com.metamatrix.admin.objects
Class MMRole

java.lang.Object
  com.metamatrix.admin.objects.MMAdminObject
      com.metamatrix.admin.objects.MMRole

All Implemented Interfaces:

AdminObject, Role, java.io.Serializable

public class MMRole
extends MMAdminObject
implements Role

Since:

4.3

See Also:

Serialized Form

Field Summary

Fields inherited from class com.metamatrix.admin.objects.MMAdminObject

deployed, enabled, identifier, identifierParts, name, OBJECT_TYPE_CACHE, OBJECT_TYPE_CONNECTOR_BINDING, OBJECT_TYPE_CONNECTOR_TYPE, OBJECT_TYPE_DQP, OBJECT_TYPE_ENTITLEMENT, OBJECT_TYPE_EXTENSION_MODULE, OBJECT_TYPE_GROUP, OBJECT_TYPE_HOST, OBJECT_TYPE_LOG_CONFIGURATION, OBJECT_TYPE_MODEL, OBJECT_TYPE_PROCESS_OBJECT, OBJECT_TYPE_PROPERTY_DEFINITION, OBJECT_TYPE_QUEUE_WORKER_POOL, OBJECT_TYPE_REQUEST, OBJECT_TYPE_RESOURCE, OBJECT_TYPE_ROLE, OBJECT_TYPE_SERVICE, OBJECT_TYPE_SESSION, OBJECT_TYPE_SYSTEM_OBJECT, OBJECT_TYPE_TRANSACTION, OBJECT_TYPE_USER, OBJECT_TYPE_VDB, OBJECTS_PACKAGE, registered, serialVersionUID

Fields inherited from interface com.metamatrix.admin.api.objects.Role

ADMIN_PRODUCT, ADMIN_READONLY, ADMIN_SYSTEM

Fields inherited from interface com.metamatrix.admin.api.objects.AdminObject

DELIMITER, DELIMITER_CHAR, ESCAPED_DELIMITER, ESCAPED_WILDCARD, WILDCARD

Constructor Summary

MMRole(java.lang.String[] identifier)
Ctor

Method Summary

static java.lang.String[]	getAvailableRoles() Get the names of all administrative roles in the system.
java.lang.String	getIdentifier() Get the fully-qualified identifier
java.lang.String	getName() Get the Name for this Admin Object
java.util.Properties	getProperties() Get all the properties for this Object.
java.lang.String	getPropertyValue(java.lang.String name) Returns a property value for the given property name
java.lang.String	toString() Get MetaMatrix Object as a String

Methods inherited from class com.metamatrix.admin.objects.MMAdminObject

buildIdentifier, buildIdentifierArray, buildIdentifierList, getCreated, getCreatedBy, getCreatedDate, getIdentifierArray, getLastChangedBy, getLastChangedDate, getLastUpdated, getLastUpdatedBy, getNameFromIdentifier, getObjectType, getParentName, getPropertiesAsString, getProps, isDeployed, isEnabled, isRegistered, setCreated, setCreatedBy, setDeployed, setEnabled, setIdentifier, setLastUpdated, setLastUpdatedBy, setProperties, setRegistered

Methods inherited from class java.lang.Object

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

Constructor Detail

MMRole

public MMRole(java.lang.String[] identifier)

Ctor

Parameters:

identifier - the role identifier should contain the whole dotted notation in one field of the identifier so that the name contains all components.

Since:

4.3

Method Detail

getAvailableRoles

public static java.lang.String[] getAvailableRoles()

Get the names of all administrative roles in the system.

Returns:

the array of all role names suitable for adding to Principals.

Since:

4.3

getIdentifier

public java.lang.String getIdentifier()

Description copied from class: MMAdminObject

Get the fully-qualified identifier

Specified by:

getIdentifier in interface AdminObject

Overrides:

getIdentifier in class MMAdminObject

Returns:

the fully-qualified identifier

Since:

4.3

See Also:

AdminObject.getIdentifier()

getName

public java.lang.String getName()

Description copied from class: MMAdminObject

Get the Name for this Admin Object

Specified by:

getName in interface AdminObject

Overrides:

getName in class MMAdminObject

Returns:

name

Since:

4.3

See Also:

AdminObject.getName()

getProperties

public java.util.Properties getProperties()

Description copied from class: MMAdminObject

Get all the properties for this Object.

Specified by:

getProperties in interface AdminObject

Overrides:

getProperties in class MMAdminObject

Returns:

Properties object.

Since:

4.3

See Also:

AdminObject.getProperties()

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String name)

Description copied from class: MMAdminObject

Returns a property value for the given property name

Specified by:

getPropertyValue in interface AdminObject

Overrides:

getPropertyValue in class MMAdminObject

Parameters:

name - of the property value to obtain

Returns:

String property value

Since:

4.3

See Also:

AdminObject.getPropertyValue(java.lang.String)

toString

public java.lang.String toString()

Description copied from class: MMAdminObject

Get MetaMatrix Object as a String

Specified by:

toString in class MMAdminObject

Since:

4.3

See Also:

MMAdminObject.toString()