Class Role

java.lang.Object

javax.management.relation.Role

All Implemented Interfaces:: Serializable

public class Role extends Object implements Serializable

Represents a role: includes a role name and referenced MBeans (via their ObjectNames). The role value is always represented as an ArrayList collection (of ObjectNames) to homogenize the access.

The serialVersionUID of this class is -279985518429862552L.

Since:

1.5

See Also:

Constructor Summary

Constructor	Description
`Role(String roleName, List<ObjectName> roleValue)`	Make a new Role object.

Method Summary

Modifier and Type	Method	Description
`Object`	`clone()`	Clone the role object.
`String`	`getRoleName()`	Retrieves role name.
`List<ObjectName>`	`getRoleValue()`	Retrieves role value.
`static String`	`roleValueToString(List<ObjectName> roleValue)`	Returns a string for the given role value.
`void`	`setRoleName(String roleName)`	Sets role name.
`void`	`setRoleValue(List<ObjectName> roleValue)`	Sets role value.
`String`	`toString()`	Returns a string describing the role.

Methods declared in class Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`	Indicates whether some other object is "equal to" this one.
`protected void`	`finalize()`	Deprecated, for removal: This API element is subject to removal in a future version. Finalization is deprecated and subject to removal in a future release.
`final Class<?>`	`getClass()`	Returns the runtime class of this `Object`.
`int`	`hashCode()`	Returns a hash code value for this object.
`final void`	`notify()`	Wakes up a single thread that is waiting on this object's monitor.
`final void`	`notifyAll()`	Wakes up all threads that are waiting on this object's monitor.
`final void`	`wait()`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted.
`final void`	`wait(long timeoutMillis)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.
`final void`	`wait(long timeoutMillis, int nanos)`	Causes the current thread to wait until it is awakened, typically by being notified or interrupted, or until a certain amount of real time has elapsed.

Constructor Details

Role

public Role(String roleName, List<ObjectName> roleValue) throws IllegalArgumentException

Make a new Role object. No check is made that the ObjectNames in the role value exist in an MBean server. That check will be made when the role is set in a relation.

Parameters:: roleName - role name; roleValue - role value (List of ObjectName objects)
Throws:: IllegalArgumentException - if null parameter

Method Details

getRoleName

public String getRoleName()

Retrieves role name.

Returns:

the role name.

See Also:

getRoleValue

public List<ObjectName> getRoleValue()

Retrieves role value.

Returns:

ArrayList of ObjectName objects for referenced MBeans.

See Also:

setRoleName

public void setRoleName(String roleName) throws IllegalArgumentException

Sets role name.

Parameters:

roleName - role name

Throws:

IllegalArgumentException - if null parameter

See Also:

setRoleValue

public void setRoleValue(List<ObjectName> roleValue) throws IllegalArgumentException

Sets role value.

Parameters:

roleValue - List of ObjectName objects for referenced MBeans.

Throws:

IllegalArgumentException - if null parameter

See Also:

toString

public String toString()

Returns a string describing the role.

Overrides:: toString in class Object
Returns:: the description of the role.

clone

public Object clone()

Clone the role object.

Overrides:

clone in class Object

Returns:

a Role that is an independent copy of the current Role object.

See Also:

roleValueToString

public static String roleValueToString(List<ObjectName> roleValue) throws IllegalArgumentException

Returns a string for the given role value.

Parameters:: roleValue - List of ObjectName objects
Returns:: A String consisting of the ObjectNames separated by newlines (\n).
Throws:: IllegalArgumentException - if null parameter

© 1993, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.