com.esri.adf.security.store
Class ArcGISSecurityRole

java.lang.Object
  com.esri.adf.security.store.ArcGISSecurityRole

All Implemented Interfaces:

java.io.Serializable

public class ArcGISSecurityRole
extends java.lang.Object
implements java.io.Serializable

This class encapsulates the role information for the security store. You can use the ArcGISSecurityRole object to add, modify or get roles from the security store.

See Also:

Serialized Form

Field Summary

protected java.lang.String	strRoleDesc
protected java.lang.String	strRoleName

Constructor Summary

ArcGISSecurityRole(java.lang.String rolename, java.lang.String description)
Constuctor for ArcGISSecurityRole class that takes in the unique name for a role and a description string.

Method Summary

protected java.util.HashMap<java.lang.String,java.lang.String>	getAllProperties() Returns a hashmap of all the properties that have been set on this object.
java.lang.String	getDescription() Returns the role description.
java.lang.String	getRoleName() Returns the role name.
void	setDescription(java.lang.String description) Set the description for the role.
void	setRoleName(java.lang.String roleName) Sets the unique identifier for a role.

Methods inherited from class java.lang.Object

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

Field Detail

strRoleName

protected java.lang.String strRoleName

strRoleDesc

protected java.lang.String strRoleDesc

Constructor Detail

ArcGISSecurityRole

public ArcGISSecurityRole(java.lang.String rolename,
                          java.lang.String description)
                   throws ArcGISSecurityException

Constuctor for ArcGISSecurityRole class that takes in the unique name for a role and a description string.

Parameters:

rolename - - unique name for the role

description - - description for the role

Throws:

ArcGISSecurityException - - if input parameters are null

Method Detail

setDescription

public void setDescription(java.lang.String description)
                    throws ArcGISSecurityException

Set the description for the role.

Parameters:

description - - description for the role

Throws:

ArcGISSecurityException - - if input parameter is null

setRoleName

public void setRoleName(java.lang.String roleName)
                 throws ArcGISSecurityException

Sets the unique identifier for a role.

Parameters:

roleName - - String representing the unique identifier for role

Throws:

ArcGISSecurityException - - if the input parameter is null.

getRoleName

public java.lang.String getRoleName()

Returns the role name.

Returns:

String representing the unique identifier for the role.

getDescription

public java.lang.String getDescription()

Returns the role description.

Returns:

String representing the description for the role. If none is set, this will return a null.

getAllProperties

protected java.util.HashMap<java.lang.String,java.lang.String> getAllProperties()

Returns a hashmap of all the properties that have been set on this object. The hashmap will include only those properties that are not null.

Returns:

Hashmap of all properties as key value pairs