edu.internet2.middleware.subject.provider

Class LdapSubject

java.lang.Object

edu.internet2.middleware.subject.provider.SubjectImpl

edu.internet2.middleware.subject.provider.LdapSubject

All Implemented Interfaces:

Subject, Serializable

public class LdapSubject
extends SubjectImpl

Ldap Subject implementation.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LdapSubject(String id, String name, String description, String type, String sourceId)
protected	LdapSubject(String id, String name, String description, String type, String sourceId, Map<String,Set<String>> attributes)
protected	LdapSubject(String id, String name, String description, String type, String sourceId, Map<String,Set<String>> attributes, String nameAttribute, String descriptionAttribute)
protected	LdapSubject(String id, String name, String description, String type, String sourceId, String nameAttribute, String descriptionAttribute)

Method Summary

Methods

Modifier and Type	Method and Description
Map<String,Set<String>>	getAttributes() Gets a map attribute names and values.
String	getAttributeValue(String name1) Returns the value of a single-valued attribute.
String	getAttributeValueOrCommaSeparated(String attributeName) Returns the attribute value if single-valued, or if multi-valued, returns the values comma separated (with a space too).
Set<String>	getAttributeValues(String name1) Returns the values of a multi-valued attribute, or a set of size one for a single valued attribute.
String	getAttributeValueSingleValued(String attributeName) Returns the attribute value if single-valued, or if multi-valued, throws an exception.
String	getDescription() Gets this Subject's description.
String	getName() Gets this Subject's name.
void	setAttributesGotten(boolean v)

Methods inherited from class edu.internet2.middleware.subject.provider.SubjectImpl

attributeValueOrCommaSeparated, attributeValueOrCommaSeparated, equals, equalsStatic, getAttributes, getAttributeValue, getAttributeValueOrCommaSeparated, getAttributeValues, getAttributeValueSingleValued, getDescriptionOverride, getId, getNameOverride, getSource, getSourceId, getType, getTypeName, hashCode, hashcodeStatic, initVirtualAttributes, setAttributes, setDescription, setId, setName, setSourceId, setTypeName, toAttributeMap, toString, toStringStatic, virtualAttributesForSource, virtualAttributeVariablesForSource

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapSubject

protected LdapSubject(String id,
           String name,
           String description,
           String type,
           String sourceId)

LdapSubject

protected LdapSubject(String id,
           String name,
           String description,
           String type,
           String sourceId,
           Map<String,Set<String>> attributes)

LdapSubject

protected LdapSubject(String id,
           String name,
           String description,
           String type,
           String sourceId,
           String nameAttribute,
           String descriptionAttribute)

LdapSubject

protected LdapSubject(String id,
           String name,
           String description,
           String type,
           String sourceId,
           Map<String,Set<String>> attributes,
           String nameAttribute,
           String descriptionAttribute)

Method Detail

setAttributesGotten

public void setAttributesGotten(boolean v)

Parameters:

v - have attributes been acquired

getName

public String getName()

Description copied from class: SubjectImpl

Gets this Subject's name.

Specified by:

getName in interface Subject

Overrides:

getName in class SubjectImpl

Returns:

name or null if not there

getDescription

public String getDescription()

Description copied from class: SubjectImpl

Gets this Subject's description.

Specified by:

getDescription in interface Subject

Overrides:

getDescription in class SubjectImpl

Returns:

description or null if not there

getAttributes

public Map<String,Set<String>> getAttributes()

Description copied from interface: Subject

Gets a map attribute names and values. The map's key contains the attribute name and the map's value contains a Set of attribute value(s). This does not return internal attributes. Note, the keys are case-insensitive

Specified by:

getAttributes in interface Subject

Overrides:

getAttributes in class SubjectImpl

Returns:

map or empty map or null if not there

See Also:

Subject.getAttributes()

getAttributeValue

public String getAttributeValue(String name1)

Description copied from interface: Subject

Returns the value of a single-valued attribute. If multivalued, this returns the first value. This does not return values for internal attributes. Note, the keys are case-insensitive

Specified by:

getAttributeValue in interface Subject

Overrides:

getAttributeValue in class SubjectImpl

Returns:

value or null if not found

See Also:

Subject.getAttributeValue(java.lang.String, boolean)

getAttributeValueOrCommaSeparated

public String getAttributeValueOrCommaSeparated(String attributeName)

Description copied from interface: Subject

 Returns the attribute value if single-valued, or
 if multi-valued, returns the values comma separated (with a space too).
 So if the values are: a b c; this would return the string: "a, b, c"
 Implementors can use the static helper in SubjectImpl.
 This does not return values for internal attributes.
 Note, the keys are case-insensitive
 

Specified by:

getAttributeValueOrCommaSeparated in interface Subject

Overrides:

getAttributeValueOrCommaSeparated in class SubjectImpl

Returns:

value or values or null if not there

See Also:

Subject.getAttributeValueOrCommaSeparated(java.lang.String)

getAttributeValues

public Set<String> getAttributeValues(String name1)

Description copied from interface: Subject

Returns the values of a multi-valued attribute, or a set of size one for a single valued attribute. Note the returned set should not be changed. This does not return values for internal attributes. Note, the keys are case-insensitive

Specified by:

getAttributeValues in interface Subject

Overrides:

getAttributeValues in class SubjectImpl

Returns:

set or empty set or null if not there

See Also:

Subject.getAttributeValues(java.lang.String)

getAttributeValueSingleValued

public String getAttributeValueSingleValued(String attributeName)

Description copied from interface: Subject

Returns the attribute value if single-valued, or if multi-valued, throws an exception. Implementors can use the static helper in SubjectImpl. This does not return values for internal attributes. Note, the keys are case-insensitive

Specified by:

getAttributeValueSingleValued in interface Subject

Overrides:

getAttributeValueSingleValued in class SubjectImpl

Returns:

value or null if not there

See Also:

Subject.getAttributeValueSingleValued(java.lang.String)