edu.internet2.middleware.grouper.app.loader.ldap
Class LoaderLdapUtils

java.lang.Object
  edu.internet2.middleware.grouper.app.loader.ldap.LoaderLdapUtils

public class LoaderLdapUtils
extends Object

utility methods and constants for ldap loader

ATTR_DEF_EXTENSION_MARKER

public static final String ATTR_DEF_EXTENSION_MARKER

extension of the attribute def name for the marker attribute for grouper loader

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_QUARTZ_CRON

public static final String ATTR_DEF_EXTENSION_QUARTZ_CRON

extension of the attribute def name for the quartz cron configuration

See Also:

Constant Field Values

LOADER_LDAP_DEF

public static final String LOADER_LDAP_DEF

loader ldap def extension

See Also:

Constant Field Values

LOADER_LDAP_VALUE_DEF

public static final String LOADER_LDAP_VALUE_DEF

loader ldap value def extension

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_TYPE

public static final String ATTR_DEF_EXTENSION_TYPE

extension of the attribute def name for type of ldap loader (e.g. LDAP_SIMPLE). Like the SQL loader, this holds the type of job from the GrouperLoaderType enum, currently the only valid values are LDAP_SIMPLE, LDAP_GROUP_LIST, LDAP_GROUPS_FROM_ATTRIBUTES. Simple is a group loaded from LDAP filter which returns subject ids or identifiers. Group list is an LDAP filter which returns group objects, and the group objects have a list of subjects. Groups from attributes is an LDAP filter that returns subjects which have a multi-valued attribute e.g. affiliations where groups will be created based on subject who have each attribute value

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_SERVER_ID

public static final String ATTR_DEF_EXTENSION_SERVER_ID

extension of the attribute def name for the server id of the ldap config (e.g. myLdap)

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_FILTER

public static final String ATTR_DEF_EXTENSION_LDAP_FILTER

extension of attribute def name for ldap filter to run to find the objects that have the subject id

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_SEARCH_DN

public static final String ATTR_DEF_EXTENSION_LDAP_SEARCH_DN

extension of attribute def name for ldap filter run in a dn (optional though recommended)

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_AND_GROUPS

public static final String ATTR_DEF_EXTENSION_LDAP_AND_GROUPS

extension of attribute def name for ldap "and groups" (must be in these comma separated group names)

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_PRIORITY

public static final String ATTR_DEF_EXTENSION_LDAP_PRIORITY

Quartz has a fixed threadpool (max configured in the grouper-loader.properties), and when the max is reached, then jobs are prioritized by this integer. The higher the better, and the default if not set is 5.

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_SUBJECT_ATTRIBUTE

public static final String ATTR_DEF_EXTENSION_SUBJECT_ATTRIBUTE

extension of attribute def name for the name of the attribute in the ldap object that is returned by the ldap filter which has the subject id or identifier in it. e.g. hasMember

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_SOURCE_ID

public static final String ATTR_DEF_EXTENSION_SOURCE_ID

extension of the attribute def name for the source id of all subjects inside

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_SUBJECT_ID_TYPE

public static final String ATTR_DEF_EXTENSION_SUBJECT_ID_TYPE

extension of the attribute def name for subjectId, subjectIdentifier, or subjectIdOrIdentifier (default)

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_SEARCH_SCOPE

public static final String ATTR_DEF_EXTENSION_SEARCH_SCOPE

extension of the attribute def name for search scope, needs to be one of: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_GROUPS_LIKE

public static final String ATTR_DEF_EXTENSION_GROUPS_LIKE

extension of the attribute def name for groups like string for sql to remove orphans of LDAP_GROUP_LIST

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_GROUP_ATTRIBUTE

public static final String ATTR_DEF_EXTENSION_LDAP_GROUP_ATTRIBUTE

Attribute name of the filter object result that holds the group name

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_ATTRIBUTE_FILTER_EXPRESSION

public static final String ATTR_DEF_EXTENSION_LDAP_ATTRIBUTE_FILTER_EXPRESSION

attribute def name of attribute filter expression

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_EXTRA_ATTRIBUTES

public static final String ATTR_DEF_EXTENSION_LDAP_EXTRA_ATTRIBUTES

Attribute name of the filter object result that holds the extra attributes

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_GROUP_NAME_EXPRESSION

public static final String ATTR_DEF_EXTENSION_LDAP_GROUP_NAME_EXPRESSION

Attribute name of name expression

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_GROUP_DISPLAY_NAME_EXPRESSION

public static final String ATTR_DEF_EXTENSION_LDAP_GROUP_DISPLAY_NAME_EXPRESSION

Attribute name of display name expression

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_GROUP_DESCRIPTION_EXPRESSION

public static final String ATTR_DEF_EXTENSION_LDAP_GROUP_DESCRIPTION_EXPRESSION

Attribute name of description expression

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_SUBJECT_EXPRESSION

public static final String ATTR_DEF_EXTENSION_LDAP_SUBJECT_EXPRESSION

Attribute name of subject expression

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_GROUP_TYPES

public static final String ATTR_DEF_EXTENSION_LDAP_GROUP_TYPES

Attribute name of group types

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_READERS

public static final String ATTR_DEF_EXTENSION_LDAP_READERS

Attribute name of readers

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_VIEWERS

public static final String ATTR_DEF_EXTENSION_LDAP_VIEWERS

Attribute name of viewers

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_UPDATERS

public static final String ATTR_DEF_EXTENSION_LDAP_UPDATERS

Attribute name of updaters

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_ADMINS

public static final String ATTR_DEF_EXTENSION_LDAP_ADMINS

Attribute name of admins

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_OPTINS

public static final String ATTR_DEF_EXTENSION_LDAP_OPTINS

Attribute name of optins

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_OPTOUTS

public static final String ATTR_DEF_EXTENSION_LDAP_OPTOUTS

Attribute name of optouts

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_GROUP_ATTR_READERS

public static final String ATTR_DEF_EXTENSION_LDAP_GROUP_ATTR_READERS

Attribute name of groupAttrReaders

See Also:

Constant Field Values

ATTR_DEF_EXTENSION_LDAP_GROUP_ATTR_UPDATERS

public static final String ATTR_DEF_EXTENSION_LDAP_GROUP_ATTR_UPDATERS

Attribute name of groupAttrUpdaters

See Also:

Constant Field Values

LoaderLdapUtils

public LoaderLdapUtils()

grouperLoaderLdapStemName

public static String grouperLoaderLdapStemName()

stem name for loader ldap attributes

Returns:

stem name

grouperLoaderLdapName

public static String grouperLoaderLdapName()

attribute def name of marker attribute

Returns:

name

grouperLoaderLdapAttributeDefName

public static AttributeDefName grouperLoaderLdapAttributeDefName()

return attribute def name for attribute type marker

Returns:

attribute def name

grouperLoaderLdapAttributeDefName

public static AttributeDefName grouperLoaderLdapAttributeDefName(boolean exceptionIfNotFound)

return attribute def name for attribute type marker

Parameters:

exceptionIfNotFound -

Returns:

attribute def name

grouperLoaderLdapQuartzCronName

public static String grouperLoaderLdapQuartzCronName()

attribute def name of quartz cron

Returns:

name

grouperLoaderLdapQuartzCronAttributeDefName

public static AttributeDefName grouperLoaderLdapQuartzCronAttributeDefName()

return attribute def name for attribute quartz cron

Returns:

attribute def name

grouperLoaderLdapTypeName

public static String grouperLoaderLdapTypeName()

attribute def name of job type

Returns:

name

grouperLoaderLdapTypeAttributeDefName

public static AttributeDefName grouperLoaderLdapTypeAttributeDefName()

return attribute def name for ldap type

Returns:

attribute def name

grouperLoaderLdapServerIdName

public static String grouperLoaderLdapServerIdName()

attribute def name of server id

Returns:

name

grouperLoaderLdapServerIdAttributeDefName

public static AttributeDefName grouperLoaderLdapServerIdAttributeDefName()

return attribute def name for attribute server id

Returns:

attribute def name

grouperLoaderLdapFilterName

public static String grouperLoaderLdapFilterName()

attribute def name of filter name

Returns:

name

grouperLoaderLdapFilterAttributeDefName

public static AttributeDefName grouperLoaderLdapFilterAttributeDefName()

return attribute def name for attribute ldap filter

Returns:

attribute def name

grouperLoaderLdapSearchDnName

public static String grouperLoaderLdapSearchDnName()

attribute def name of search dn

Returns:

name

grouperLoaderLdapSearchDnAttributeDefName

public static AttributeDefName grouperLoaderLdapSearchDnAttributeDefName()

return attribute def name for attribute search dn

Returns:

attribute def name

grouperLoaderLdapPriorityName

public static String grouperLoaderLdapPriorityName()

attribute def name of priority

Returns:

name

grouperLoaderLdapPriorityAttributeDefName

public static AttributeDefName grouperLoaderLdapPriorityAttributeDefName()

return attribute def name for attribute quartz priority

Returns:

attribute def name

grouperLoaderLdapAndGroupsName

public static String grouperLoaderLdapAndGroupsName()

attribute def name of "and groups" (must be in these comma separated group names)

Returns:

name

grouperLoaderLdapAndGroupsAttributeDefName

public static AttributeDefName grouperLoaderLdapAndGroupsAttributeDefName()

return attribute def name for attribute "and groups"

Returns:

attribute def name

grouperLoaderLdapSubjectAttributeName

public static String grouperLoaderLdapSubjectAttributeName()

attribute def name of subject attribute

Returns:

name

grouperLoaderLdapSubjectAttributeAttributeDefName

public static AttributeDefName grouperLoaderLdapSubjectAttributeAttributeDefName()

return attribute def name for attribute subject attribute

Returns:

attribute def name

grouperLoaderLdapSourceIdName

public static String grouperLoaderLdapSourceIdName()

attribute def name of source id

Returns:

name

grouperLoaderLdapSourceIdAttributeDefName

public static AttributeDefName grouperLoaderLdapSourceIdAttributeDefName()

return attribute def name for attribute source id

Returns:

attribute def name

grouperLoaderLdapSubjectIdTypeName

public static String grouperLoaderLdapSubjectIdTypeName()

attribute def name of subject id type

Returns:

name

grouperLoaderLdapSubjectIdTypeAttributeDefName

public static AttributeDefName grouperLoaderLdapSubjectIdTypeAttributeDefName()

return attribute def name for attribute subject id type

Returns:

attribute def name

grouperLoaderLdapSearchScopeName

public static String grouperLoaderLdapSearchScopeName()

attribute def name of search scope name

Returns:

name

grouperLoaderLdapSearchScopeAttributeDefName

public static AttributeDefName grouperLoaderLdapSearchScopeAttributeDefName()

return attribute def name for attribute

Returns:

attribute def name

grouperLoaderLdapGroupsLikeName

public static String grouperLoaderLdapGroupsLikeName()

attribute def name of groups like string for sql to remove orphans of LDAP_GROUP_LIST

Returns:

name

grouperLoaderLdapGroupsLikeAttributeDefName

public static AttributeDefName grouperLoaderLdapGroupsLikeAttributeDefName()

return attribute def name for attribute groups like string for sql to remove orphans of LDAP_GROUP_LIST

Returns:

attribute def name

attributeLoaderLdapStemName

public static String attributeLoaderLdapStemName()

return the stem name where the limit attributes go, without colon on end

Returns:

stem name

grouperLoaderLdapGroupAttributeName

public static String grouperLoaderLdapGroupAttributeName()

attribute def name of group attribute

Returns:

name

grouperLoaderLdapGroupAttributeAttributeDefName

public static AttributeDefName grouperLoaderLdapGroupAttributeAttributeDefName()

return attribute def name for attribute group attribute

Returns:

attribute def name

grouperLoaderLdapAttributeFilterExpressionName

public static String grouperLoaderLdapAttributeFilterExpressionName()

attribute def name of attribute filter expression

Returns:

name

grouperLoaderLdapAttributeFilterExpressionAttributeDefName

public static AttributeDefName grouperLoaderLdapAttributeFilterExpressionAttributeDefName()

return attribute def name of attribute filter expression

Returns:

attribute def name

grouperLoaderLdapExtraAttributesName

public static String grouperLoaderLdapExtraAttributesName()

attribute def name of extra attributes

Returns:

name

grouperLoaderLdapExtraAttributesAttributeDefName

public static AttributeDefName grouperLoaderLdapExtraAttributesAttributeDefName()

return attribute def name for attribute extra attributes

Returns:

attribute def name

grouperLoaderLdapGroupNameExpressionName

public static String grouperLoaderLdapGroupNameExpressionName()

attribute def name of group name expression

Returns:

name

grouperLoaderLdapGroupNameExpressionAttributeDefName

public static AttributeDefName grouperLoaderLdapGroupNameExpressionAttributeDefName()

return attribute def name for group name expression

Returns:

attribute def name

grouperLoaderLdapGroupDisplayNameExpressionName

public static String grouperLoaderLdapGroupDisplayNameExpressionName()

attribute def name of group display name expression

Returns:

name

grouperLoaderLdapGroupDisplayNameExpressionAttributeDefName

public static AttributeDefName grouperLoaderLdapGroupDisplayNameExpressionAttributeDefName()

return attribute def name for group dislpay name expression

Returns:

attribute def name

grouperLoaderLdapGroupDescriptionExpressionName

public static String grouperLoaderLdapGroupDescriptionExpressionName()

attribute def name of group description expression

Returns:

name

grouperLoaderLdapGroupDescriptionExpressionAttributeDefName

public static AttributeDefName grouperLoaderLdapGroupDescriptionExpressionAttributeDefName()

return attribute def name for group description expression

Returns:

attribute def name

limitLoaderElClasses

public static Map<String,Object> limitLoaderElClasses()

custom el instances to add to the variable map for ldap loader EL

Returns:

the map

substituteEl

public static String substituteEl(String expression,
                                  Map<String,Object> loaderEnvVars)

substitute expression

Parameters:

expression -

loaderEnvVars -

Returns:

the evaluation

grouperLoaderLdapSubjectExpressionName

public static String grouperLoaderLdapSubjectExpressionName()

attribute def name of subject expression

Returns:

name

grouperLoaderLdapSubjectExpressionAttributeDefName

public static AttributeDefName grouperLoaderLdapSubjectExpressionAttributeDefName()

return attribute def name for subject expression

Returns:

attribute def name

grouperLoaderLdapGroupTypesName

public static String grouperLoaderLdapGroupTypesName()

attribute def name of group types

Returns:

name

grouperLoaderLdapGroupTypesAttributeDefName

public static AttributeDefName grouperLoaderLdapGroupTypesAttributeDefName()

return attribute def name for group types

Returns:

attribute def name

grouperLoaderLdapReadersName

public static String grouperLoaderLdapReadersName()

attribute def name of readers

Returns:

name

grouperLoaderLdapReadersAttributeDefName

public static AttributeDefName grouperLoaderLdapReadersAttributeDefName()

return attribute def name for readers

Returns:

attribute def name

grouperLoaderLdapViewersName

public static String grouperLoaderLdapViewersName()

attribute def name of viewers

Returns:

name

grouperLoaderLdapViewersAttributeDefName

public static AttributeDefName grouperLoaderLdapViewersAttributeDefName()

return attribute def name for viewers

Returns:

attribute def name

grouperLoaderLdapUpdatersName

public static String grouperLoaderLdapUpdatersName()

attribute def name of updaters

Returns:

name

grouperLoaderLdapUpdatersAttributeDefName

public static AttributeDefName grouperLoaderLdapUpdatersAttributeDefName()

return attribute def name for updaters

Returns:

attribute def name

grouperLoaderLdapAdminsName

public static String grouperLoaderLdapAdminsName()

attribute def name of admins

Returns:

name

grouperLoaderLdapAdminsAttributeDefName

public static AttributeDefName grouperLoaderLdapAdminsAttributeDefName()

return attribute def name for admins

Returns:

attribute def name

grouperLoaderLdapOptinsName

public static String grouperLoaderLdapOptinsName()

attribute def name of optins

Returns:

name

grouperLoaderLdapOptinsAttributeDefName

public static AttributeDefName grouperLoaderLdapOptinsAttributeDefName()

return attribute def name for optins

Returns:

attribute def name

grouperLoaderLdapOptoutsName

public static String grouperLoaderLdapOptoutsName()

attribute def name of optouts

Returns:

name

grouperLoaderLdapOptoutsAttributeDefName

public static AttributeDefName grouperLoaderLdapOptoutsAttributeDefName()

return attribute def name for optouts

Returns:

attribute def name

grouperLoaderLdapGroupAttrReadersName

public static String grouperLoaderLdapGroupAttrReadersName()

attribute def name of groupAttrReaders

Returns:

name

grouperLoaderLdapGroupAttrReadersAttributeDefName

public static AttributeDefName grouperLoaderLdapGroupAttrReadersAttributeDefName()

return attribute def name for groupAttrReaders

Returns:

attribute def name

grouperLoaderLdapGroupAttrUpdatersName

public static String grouperLoaderLdapGroupAttrUpdatersName()

attribute def name of groupAttrUpdaters

Returns:

name

grouperLoaderLdapGroupAttrUpdatersAttributeDefName

public static AttributeDefName grouperLoaderLdapGroupAttrUpdatersAttributeDefName()

return attribute def name for groupAttrUpdaters

Returns:

attribute def name