FileDocCategorySizeDatePackage
JMXPrincipal.javaAPI DocJava SE 5 API3076Fri Aug 26 14:57:38 BST 2005javax.management.remote

JMXPrincipal

public class JMXPrincipal extends Object implements Serializable, Principal

The identity of a remote client of the JMX Remote API.

Principals such as this JMXPrincipal may be associated with a particular Subject to augment that Subject with an additional identity. Refer to the {@link javax.security.auth.Subject} class for more information on how to achieve this. Authorization decisions can then be based upon the Principals associated with a Subject.

see
java.security.Principal
see
javax.security.auth.Subject
since
1.5
since.unbundled
1.0

Fields Summary
private static final long
serialVersionUID
private String
name
Constructors Summary
public JMXPrincipal(String name)

Creates a JMXPrincipal for a given identity.

param
name the JMX Remote API name for this identity.
exception
NullPointerException if the name is null.


                                 
       
        if (name == null)
            throw new NullPointerException("illegal null input");

        this.name = name;
    
Methods Summary
public booleanequals(java.lang.Object o)
Compares the specified Object with this JMXPrincipal for equality. Returns true if the given object is also a JMXPrincipal and the two JMXPrincipals have the same name.

param
o Object to be compared for equality with this JMXPrincipal.
return
true if the specified Object is equal to this JMXPrincipal.

        if (o == null)
            return false;

        if (this == o)
            return true;
 
        if (!(o instanceof JMXPrincipal))
            return false;
        JMXPrincipal that = (JMXPrincipal)o;

        return (this.getName().equals(that.getName()));
    
public java.lang.StringgetName()
Returns the name of this principal.

return
the name of this JMXPrincipal.

        return name;
    
public inthashCode()
Returns a hash code for this JMXPrincipal.

return
a hash code for this JMXPrincipal.

        return name.hashCode();
    
public java.lang.StringtoString()
Returns a string representation of this JMXPrincipal.

return
a string representation of this JMXPrincipal.

        return("JMXPrincipal:  " + name);