edu.internet2.middleware.grouper.shibboleth.dataConnector

Class BaseGrouperDataConnector<T>

java.lang.Object

edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.AbstractResolutionPlugIn<Map<String,edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute>>

edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.dataConnector.BaseDataConnector

edu.internet2.middleware.grouper.shibboleth.dataConnector.BaseGrouperDataConnector<T>

All Implemented Interfaces:

edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.dataConnector.DataConnector, edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.ResolutionPlugIn<Map<String,edu.internet2.middleware.shibboleth.common.attribute.BaseAttribute>>

Direct Known Subclasses:

GroupDataConnector, MemberDataConnector, StemDataConnector

public abstract class BaseGrouperDataConnector<T>
extends edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.dataConnector.BaseDataConnector

A DataConnector which returns Grouper objects.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CHANGELOG_PRINCIPAL_NAME_PREFIX The principal name prefix required for processing of a change log entry.

Constructor Summary

Constructors

Constructor and Description
BaseGrouperDataConnector() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected Set<String>	getAllAttributeDefNames() Return all attribute definition names.
protected Set<String>	getAttributeDefNames() Returns the possibly empty set of attribute definition names defined in the attribute resolver configuration.
List<AttributeIdentifier>	getAttributeIdentifiers() Return the identifiers of the attributes to return.
Filter<T>	getFilter() Get the filter which determines the objects which will be considered by this data connector.
GrouperSession	getGrouperSession() Start a new root session if necessary, otherwise reuse existing threadlocal session.
List<GroupsField>	getGroupsFields() The representation of the attributes which return groups.
List<MembersField>	getMembersFields() The representation of the attributes which return members.
List<PrivilegeField>	getPrivilegeFields() The representation of the attributes which return privileges.
void	initialize() Make sure that the attributes to return as specified in the data connector configuration are valid, and initialize the necessary objects.
void	setAttributeIdentifiers(List<AttributeIdentifier> attributeIdentifiers) Set the identifiers of the attributes to return.
void	setFilter(Filter filter) Set the match query filter.

Methods inherited from class edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.dataConnector.BaseDataConnector

getFailoverDependencyId, setFailoverDependencyIds

Methods inherited from class edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.AbstractResolutionPlugIn

getDependencyIds, getId, getValuesFromAllDependencies, getValuesFromAttributeDependency, getValuesFromConnectorDependency, setId

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.internet2.middleware.shibboleth.common.attribute.resolver.provider.ResolutionPlugIn

getDependencyIds, getId, resolve, validate

Field Detail

CHANGELOG_PRINCIPAL_NAME_PREFIX

public static final String CHANGELOG_PRINCIPAL_NAME_PREFIX

The principal name prefix required for processing of a change log entry. A terrible hack.

See Also:

Constant Field Values

Constructor Detail

BaseGrouperDataConnector

public BaseGrouperDataConnector()

Constructor.

Method Detail

initialize

public void initialize()
                throws GrouperException

Make sure that the attributes to return as specified in the data connector configuration are valid, and initialize the necessary objects.

Throws:

GrouperException

getGrouperSession

public GrouperSession getGrouperSession()

Start a new root session if necessary, otherwise reuse existing threadlocal session.

Returns:

the root grouper session

getFilter

public Filter<T> getFilter()

Get the filter which determines the objects which will be considered by this data connector.

Returns:

the filter or null if all groups should be considered

setFilter

public void setFilter(Filter filter)

Set the match query filter.

Parameters:

filter - the Filter

setAttributeIdentifiers

public void setAttributeIdentifiers(List<AttributeIdentifier> attributeIdentifiers)

Set the identifiers of the attributes to return.

Parameters:

attributeIdentifiers -

getAttributeIdentifiers

public List<AttributeIdentifier> getAttributeIdentifiers()

Return the identifiers of the attributes to return.

Returns:

the attribute identifiers

getGroupsFields

public List<GroupsField> getGroupsFields()

The representation of the attributes which return groups.

Returns:

the groups fields

getMembersFields

public List<MembersField> getMembersFields()

The representation of the attributes which return members.

Returns:

the members fields

getPrivilegeFields

public List<PrivilegeField> getPrivilegeFields()

The representation of the attributes which return privileges.

Returns:

the privileges fields

getAttributeDefNames

protected Set<String> getAttributeDefNames()

Returns the possibly empty set of attribute definition names defined in the attribute resolver configuration.

Returns:

the possibly empty set of attribute definition names

getAllAttributeDefNames

protected Set<String> getAllAttributeDefNames()

Return all attribute definition names.

Returns:

all attribute definition names.