Package com.sun.identity.entitlement.opensso

Class OpenSSOSubjectAttributesCollector

java.lang.Object

com.sun.identity.entitlement.opensso.OpenSSOSubjectAttributesCollector

All Implemented Interfaces:

SubjectAttributesCollector

public class OpenSSOSubjectAttributesCollector
extends Object
implements SubjectAttributesCollector

Author:

dennis

Field Summary

Fields inherited from interface com.sun.identity.entitlement.SubjectAttributesCollector

ATTR_NAME_ALL_ENTITIES, NAMESPACE_ATTR, NAMESPACE_IDENTITY

Constructor Summary

Constructors

Constructor	Description
OpenSSOSubjectAttributesCollector()

Method Summary

Modifier and Type	Method	Description
Map<String,Set<String>>	getAttributes(Subject subject, Set<String> attributeNames)	Returns the attribute values of the given user represented by Subject object.
Set<String>	getAvailableSubjectAttributeNames()	Returns available subject attribute names.
Map<String,Set<String>>	getUserAttributes(Subject subject, Set<String> attrNames)	Returns the attribute values of the given user represented by Subject object.
void	init(String realm, Map<String,Set<String>> configMap)	Initializes this object with specified parameters.
boolean	isGroupMembershipSearchIndexEnabled()	Returns true if group membership search index is enabled or false otherwise.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenSSOSubjectAttributesCollector

public OpenSSOSubjectAttributesCollector()

Method Detail

init

public void init(String realm,
                 Map<String,Set<String>> configMap)

Initializes this object with specified parameters.

Specified by:

init in interface SubjectAttributesCollector

Parameters:

realm - the realm

configMap - configuration map

getAttributes

public Map<String,Set<String>> getAttributes(Subject subject,
                                                   Set<String> attributeNames)
                                            throws EntitlementException

Description copied from interface: SubjectAttributesCollector

Returns the attribute values of the given user represented by Subject object.

Specified by:

getAttributes in interface SubjectAttributesCollector

Parameters:

subject - identity of the user

attributeNames - requested attribute names

Returns:

a map of attribute names and their values

Throws:

EntitlementException - if this operation failed.

getAvailableSubjectAttributeNames

public Set<String> getAvailableSubjectAttributeNames()
                                              throws EntitlementException

Description copied from interface: SubjectAttributesCollector

Returns available subject attribute names.

Specified by:

getAvailableSubjectAttributeNames in interface SubjectAttributesCollector

Returns:

a set of available subject attribute names or empty CaseInsensitiveHashSet if not found

Throws:

EntitlementException

isGroupMembershipSearchIndexEnabled

public boolean isGroupMembershipSearchIndexEnabled()

Returns true if group membership search index is enabled or false otherwise.

Specified by:

isGroupMembershipSearchIndexEnabled in interface SubjectAttributesCollector

Returns:

true if group membership search index is enabled or false otherwise.

getUserAttributes

public Map<String,Set<String>> getUserAttributes(Subject subject,
                                                       Set<String> attrNames)
                                                throws EntitlementException

Returns the attribute values of the given user represented by Subject object.

Specified by:

getUserAttributes in interface SubjectAttributesCollector

Parameters:

subject - identity of the user.

attrNames - requested attribute names.

Returns:

a map of attribute names and their values

Throws:

EntitlementException - if this operation failed.