class:Role [NONE]

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:: Serialized Form

constructor:Role(java.lang.String,java.util.List) [NONE]

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:getRoleName() [NONE]

getRoleName

public String getRoleName()

Retrieves role name.

Returns:: the role name.
See Also:: setRoleName(java.lang.String)

method:getRoleValue() [NONE]

getRoleValue

public List<ObjectName> getRoleValue()

Retrieves role value.

Returns:: ArrayList of ObjectName objects for referenced MBeans.
See Also:: setRoleValue(java.util.List<javax.management.ObjectName>)

method:setRoleName(java.lang.String) [NONE]

setRoleName

public void setRoleName?(String roleName) throws IllegalArgumentException

Sets role name.

Parameters:: roleName - role name
Throws:: IllegalArgumentException - if null parameter
See Also:: getRoleName()

method:setRoleValue(java.util.List) [NONE]

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:: getRoleValue()

method:toString() [NONE]

toString

public String toString()

Returns a string describing the role.

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

method:clone() [NONE]

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:: Cloneable

method:roleValueToString(java.util.List) [NONE]

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