com.esri.gpt.framework.security.principal
Class Roles

java.lang.Object
  java.util.AbstractMap<K,V>
      java.util.HashMap<K,V>
          java.util.LinkedHashMap<String,T>
              com.esri.gpt.framework.collection.CaseInsensitiveMap<T>
                  com.esri.gpt.framework.security.principal.SecurityPrincipals<Role>
                      com.esri.gpt.framework.security.principal.Roles

All Implemented Interfaces:

Serializable, Cloneable, Map<String,Role>

public class Roles
extends SecurityPrincipals<Role>

Defines a Role collection.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Constructor Summary

Roles()
Default constructor.

Method Summary

boolean	getAuthenticatedUserRequiresRole() Gets the policy regarding authenticated users and role membership.
String	getRegisteredUserRoleKey() Gets the key associated with the registered user role.
void	setAuthenticatedUserRequiresRole(boolean roleRequired) Sets the policy regarding authenticated users and role membership.
void	setRegisteredUserRoleKey(String key) Sets the key associated with the registered user role.
String	toString() Returns the string representation of the object.

Methods inherited from class com.esri.gpt.framework.security.principal.SecurityPrincipals

add

Methods inherited from class com.esri.gpt.framework.collection.CaseInsensitiveMap

containsKey, get, getAllowEmptyKey, put

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, removeEldestEntry

Methods inherited from class java.util.HashMap

clone, entrySet, isEmpty, keySet, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

entrySet, equals, hashCode, isEmpty, keySet, putAll, remove, size, values

Constructor Detail

Roles

public Roles()

Default constructor.

Method Detail

getAuthenticatedUserRequiresRole

public boolean getAuthenticatedUserRequiresRole()

Gets the policy regarding authenticated users and role membership.
If true, a user must authenticate and belong to a role based group to gain access.
If false, any user that passes authentication will be allowed access.

Returns:

the policy

setAuthenticatedUserRequiresRole

public void setAuthenticatedUserRequiresRole(boolean roleRequired)

Sets the policy regarding authenticated users and role membership.
If true, a user must authenticate and belong to a role based group to gain access.
If false, any user that passes authentication will be allowed access.

Parameters:

roleRequired - the policy

getRegisteredUserRoleKey

public String getRegisteredUserRoleKey()

Gets the key associated with the registered user role.

Returns:

the distinguished name

setRegisteredUserRoleKey

public void setRegisteredUserRoleKey(String key)

Sets the key associated with the registered user role.

Parameters:

key - the associated key

toString

public String toString()

Returns the string representation of the object.

Overrides:

toString in class CaseInsensitiveMap<Role>

Returns:

the string