edu.internet2.middleware.grouper.shibboleth.dataConnector.field
Class BaseField

java.lang.Object
  extended by edu.internet2.middleware.grouper.shibboleth.dataConnector.field.BaseField
Direct Known Subclasses:
BaseMembershipField, PrivilegeField

public class BaseField
extends Object


Field Summary
static String DELIMITER
          the identifier delimiter
 
Constructor Summary
BaseField(String id)
          Constructs a representation of an attribute with the given id.
 
Method Summary
 String getFirstIdElement()
          Get the first identifier element.
 String getId()
          Get the attribute id.
 List<String> getIdElements()
          Get the identifier as a list of component elements.
 String getSecondIdElement()
          Get the possibly null second identifier element.
 String getThirdIdElement()
          Get the possibly null third identifier element which is the name of the custom list field.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DELIMITER

public static final String DELIMITER
the identifier delimiter

See Also:
Constant Field Values
Constructor Detail

BaseField

public BaseField(String id)
          throws GrouperException
Constructs a representation of an attribute with the given id. Valid ids are the following :
 admins
 optins
 optouts
 readers
 updaters
 viewers
 members
 members:all
 members:immediate
 members:effective
 members:composite
 members:all:customList
 members:immediate:customList
 members:effective:customList
 members:composite:customList
 groups
 groups:all
 groups:immediate
 groups:effective
 groups:composite
 groups:all:customList
 groups:immediate:customList
 roups:effective:customList
 groups:composite:customList
 

Parameters:
id - the identifier
Throws:
GrouperException - if the identifier is invalid
Method Detail

getId

public String getId()
Get the attribute id.

Returns:
the name of the underlying attribute

getIdElements

public List<String> getIdElements()
Get the identifier as a list of component elements.

Returns:
the identifier as a list of component elements

getFirstIdElement

public String getFirstIdElement()
Get the first identifier element. Should never be null. Should be "groups", "members", or an AccessPrivilege name.

Returns:
"groups", "members", or an AccessPrivilege name

getSecondIdElement

public String getSecondIdElement()
Get the possibly null second identifier element. If the first id element is "groups" or "members", then the second element should be one of "all", "immediate", "effective" or "composite".

Returns:
"all", "immediate", "effective" or "composite" or null

getThirdIdElement

public String getThirdIdElement()
Get the possibly null third identifier element which is the name of the custom list field.

Returns:
the name of the custom list field or null


Copyright © 2012 Internet2. All Rights Reserved.