Class JMXPrincipal

java.lang.Object

javax.management.remote.JMXPrincipal

All Implemented Interfaces:

Serializable, Principal

public class JMXPrincipal
extends Object
implements Principal, Serializable

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 Subject class for more information on how to achieve this. Authorization decisions can then be based upon the Principals associated with a Subject.

Since:

1.5

See Also:

• Principal
• Subject
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
JMXPrincipal(String name)	Creates a JMXPrincipal for a given identity.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Compares the specified Object with this JMXPrincipal for equality.
String	getName()	Returns the name of this principal.
int	hashCode()	Returns a hash code for this JMXPrincipal.
String	toString()	Returns a string representation of this JMXPrincipal.

Methods declared in class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Modifier and Type	Method	Description
protected Object	clone()	Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
protected void	finalize()	Deprecated, for removal: This API element is subject to removal in a future version. May cause performance issues, deadlocks and hangs.
final Class<? extends Object>	getClass()	Answers the unique instance of java.lang.Class which represents the class of the receiver.
final void	notify()	Causes one thread which is waiting on the receiver to be made ready to run.
final void	notifyAll()	Causes all threads which are waiting on the receiver to be made ready to run.
final void	wait()	Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by notify or notifyAll).
final void	wait(long time)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.
final void	wait(long time, int frac)	Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by notify or notifyAll) or the expiration of the timeout.

Methods declared in interface Principal

implies

Modifier and Type	Method	Description
default boolean	implies(Subject subject)	Returns true if the specified subject is implied by this Principal.

Constructor Details

JMXPrincipal

public JMXPrincipal(String name)

Creates a JMXPrincipal for a given identity.

Parameters:

name - the JMX Remote API name for this identity.

Throws:

NullPointerException - if the name is null.

Method Details

getName

public String getName()

Returns the name of this principal.

Specified by:

getName in interface Principal

Returns:

the name of this JMXPrincipal.

toString

public String toString()

Returns a string representation of this JMXPrincipal.

Specified by:

toString in interface Principal

Overrides:

toString in class Object

Returns:

a string representation of this JMXPrincipal.

equals

public boolean equals(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.

Specified by:

equals in interface Principal

Overrides:

equals in class Object

Parameters:

o - Object to be compared for equality with this JMXPrincipal.

Returns:

true if the specified Object is equal to this JMXPrincipal.

See Also:

• Object.hashCode()

hashCode

public int hashCode()

Returns a hash code for this JMXPrincipal.

Specified by:

hashCode in interface Principal

Overrides:

hashCode in class Object

Returns:

a hash code for this JMXPrincipal.

See Also:

• Object.equals(Object)