Class LoaderJobBean
java.lang.Object
edu.internet2.middleware.grouper.app.loader.LoaderJobBean
bean to hold objects for loader job
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
constant for field name for: andGroupsstatic final String
constant for field name for: attributeDefNamestatic final String
constant for field name for: attributeLoaderActionQuerystatic final String
constant for field name for: attributeLoaderActionSetQuerystatic final String
constant for field name for: attributeLoaderAttrQuerystatic final String
constant for field name for: attributeLoaderAttrSetQuerystatic final String
constant for field name for: attributeLoaderAttrsLikestatic final String
constant for field name for: groupLikeStringstatic final String
constant for field name for: groupNameOverallstatic final String
constant for field name for: groupQuerystatic final String
constant for field name for: groupTypesstatic final String
constant for field name for: grouperLoaderDbstatic final String
constant for field name for: grouperLoaderTypestatic final String
constant for field name for: grouperSessionstatic final String
constant for field name for: hib3GrouploaderLogOverallstatic final String
constant for field name for: ldapAttributeFilterExpressionstatic final String
constant for field name for: ldapExtraAttributesstatic final String
constant for field name for: ldapFilterstatic final String
constant for field name for: ldapGroupAttributestatic final String
constant for field name for: ldapGroupDescriptionExpressionstatic final String
constant for field name for: ldapGroupDisplayExtensionExpressionstatic final String
constant for field name for: ldapGroupNameExpressionstatic final String
constant for field name for: ldapQuartzCronstatic final String
constant for field name for: ldapSearchDnstatic final String
constant for field name for: ldapSearchScopestatic final String
constant for field name for: ldapServerIdstatic final String
constant for field name for: ldapSourceIdstatic final String
constant for field name for: ldapSubjectAttributestatic final String
constant for field name for: ldapSubjectExpressionstatic final String
constant for field name for: ldapSubjectIdTypestatic final String
constant for field name for: ldapTypestatic final String
constant for field name for: querystatic final String
constant for field name for: startTime -
Constructor Summary
ConstructorsConstructorDescriptionLoaderJobBean
(GrouperLoaderType grouperLoaderType1, String attributeDefName, GrouperLoaderDb grouperLoaderDb1, Hib3GrouperLoaderLog hib3GrouploaderLogOverall1, GrouperSession grouperSession1, String attributeLoaderAttrQuery1, String attributeLoaderAttrSetQuery1, String attributeLoaderAttrsLike1, String attributeLoaderActionQuery1, String attributeLoaderActionSetQuery1, long startTime1) LoaderJobBean
(GrouperLoaderType grouperLoaderType1, String groupNameOverall1, GrouperLoaderDb grouperLoaderDb1, String query1, Hib3GrouperLoaderLog hib3GrouploaderLogOverall1, GrouperSession grouperSession1, List<Group> andGroups1, List<GroupType> groupTypes1, String groupLikeString1, String groupQuery1, long startTime1, GrouperLoaderDisplayNameSyncType grouperLoaderDisplayNameSyncType, String displayNameSyncBaseFolderName, Integer displayNameSyncLevels) LoaderJobBean
(String ldapType1, String ldapServerId1, String ldapFilter1, String ldapSubjectAttribute1, String ldapSearchDn1, String ldapSourceId1, String ldapSubjectIdType1, String ldapSearchScope1, long startTime1, GrouperLoaderType grouperLoaderType1, String groupNameOverall1, Hib3GrouperLoaderLog hib3GrouploaderLogOverall1, GrouperSession grouperSession1, List<Group> andGroups1, String ldapGroupAttribute1, String extraAttributes1, String ldapGroupNameExpression1, String ldapGroupDisplayExtensionExpression1, String ldapGroupDescriptionExpression1, String ldapSubjectExpression1, List<GroupType> groupTypes1, String ldapGroupReaders1, String ldapGroupViewers1, String ldapGroupAdmins1, String ldapGroupUpdaters1, String ldapGroupOptins1, String ldapGroupOptouts1, String groupsLike1, String ldapAttributeFilterExpression1, String ldapGroupAttrReaders1, String ldapGroupAttrUpdaters1, String ldapResultsTransformationClass1) constructor for ldap jobs -
Method Summary
Modifier and TypeMethodDescriptionclone()
deep clone the fields in this objectmembers must be in these groups also to be in the overall groupattributeDef name for the jobSQL query with at least the following column: action_nameSQL query with at least the following columns: if_has_action_name, then_has_action_nameSQL query with at least some of the following columns: attr_name, attr_display_name, attr_descriptionSQL query with at least the following columns: if_has_attr_name, then_has_attr_nameIf empty, then orphans will be left alone (for attributeDefName and attributeDefNameSets).failsafe settings, defaults, etcdatabase this runs againsttype of job, e.g.grouper session (probably a root session)overall group name (if a group list job, then overall, if sql simple, then the group)group querygroup types to add to loader managed grouplog entry for the jobif filtering which attributes, this is the jexl expressionAttribute names (comma separated) to get LDAP data for expressions in group name, displayExtension, description, optional, for LDAP_GROUP_LISTLDAP filter returns objects that have subjectIds or subjectIdentifiers and group name (if LDAP_GROUP_LIST)optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can ADMIN the grouprequired for LDAP_GROUPS_FROM_ATTRIBUTES Attribute name of the filter object result that holds the group nameoptional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can GROUP_ATTR_READoptional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can GROUP_ATTR_UPDATEJEXL expression language fragment that evaluates to the group description, optional for LDAP_GROUP_LIST or LDAP_GROUPS_FROM_ATTRIBUTESJEXL expression language fragment that evaluates to the group display extension, optional for LDAP_GROUP_LIST or LDAP_GROUPS_FROM_ATTRIBUTESoptional, for LDAP_GROUP_LIST, or LDAP_GROUPS_FROM_ATTRIBUTES JEXL expression language fragment that evaluates to the group name (relative in the stem as the group which has the loader definition)optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can OPTIN their group membershipoptional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can OPTOUT their group membershipoptional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can READ the group membershipsoptional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can UPDATE the group membershipsoptional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can VIEW the groupQuartz cron config string, e.g.optional for LDAP_GROUPS_FROM_ATTRIBUTES Class to transform data from ldap for more advanced transformations (e.g.Location that constrains the subtree where the filter is applicable.How the deep in the subtree the search will take place.Server ID that is configured in the grouper-loader.properties that identifies the connection information to the LDAP serverSource ID from the subject.properties that narrows the search for subjects.Attribute name of the filter object result that holds the subject id.JEXL expression language fragment that processes the subject string before passing it to the subject APIThe type of subject ID.extension of the attribute def name for type of ldap loader (e.g.getQuery()
query for the joblong
start time of jobvoid
setAndGroups
(List<Group> andGroups1) members must be in these groups also to be in the overall groupvoid
setAttributeDefName
(String attributeDefName1) attributeDef name for the jobvoid
setAttributeLoaderActionQuery
(String attributeLoaderActionQuery1) SQL query with at least the following column: action_namevoid
setAttributeLoaderActionSetQuery
(String attributeLoaderActionSetQuery1) SQL query with at least the following columns: if_has_action_name, then_has_action_namevoid
setAttributeLoaderAttrQuery
(String attributeLoaderAttrQuery1) SQL query with at least some of the following columns: attr_name, attr_display_name, attr_descriptionvoid
setAttributeLoaderAttrSetQuery
(String attributeLoaderAttrSetQuery1) SQL query with at least the following columns: if_has_attr_name, then_has_attr_namevoid
setAttributeLoaderAttrsLike
(String attributeLoaderAttrsLike1) If empty, then orphans will be left alone (for attributeDefName and attributeDefNameSets).void
setGrouperFailsafeBean
(GrouperFailsafeBean grouperFailsafeBean1) failsafe settings, defaults, etcvoid
setGrouperLoaderDb
(GrouperLoaderDb grouperLoaderDb) db this job runs againstvoid
setGrouperLoaderType
(GrouperLoaderType grouperLoaderType) type of job, e.g.void
setGrouperSession
(GrouperSession grouperSession1) grouper session, probably a root sessionvoid
setGroupLikeString
(String groupLikeString) groups with this like DB sql string are managed by the loader.void
setGroupNameOverall
(String groupNameOverall) group name for job (if group list, this is the overall name)void
setGroupQuery
(String groupQuery1) void
setGroupTypes
(List<GroupType> groupTypes) group types to add to loader managed groupvoid
setHib3GrouploaderLogOverall
(Hib3GrouperLoaderLog hib3GrouploaderLogOverall1) void
setLdapAttributeFilterExpression
(String ldapAttributeFilterExpression1) if filtering which attributes, this is the jexl expressionvoid
setLdapExtraAttributes
(String ldapExtraAttributes1) Attribute names (comma separated) to get LDAP data for expressions in group name, displayExtension, description, optional, for LDAP_GROUP_LISTvoid
setLdapFilter
(String ldapFilter1) LDAP filter returns objects that have subjectIds or subjectIdentifiers and group name (if LDAP_GROUP_LIST)void
setLdapGroupAdmins
(String ldapGroupAdmins1) optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can ADMIN the groupvoid
setLdapGroupAttribute
(String ldapGroupAttribute1) required for LDAP_GROUPS_FROM_ATTRIBUTES Attribute name of the filter object result that holds the group namevoid
setLdapGroupAttrReaders
(String ldapGroupAttrReaders1) optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can GROUP_ATTR_READvoid
setLdapGroupAttrUpdate
(String ldapGroupAttrUpdaters1) optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can GROUP_ATTR_UPDATEvoid
setLdapGroupDescriptionExpression
(String ldapGroupDescriptionExpression1) JEXL expression language fragment that evaluates to the group description, optional for LDAP_GROUP_LIST or LDAP_GROUPS_FROM_ATTRIBUTESvoid
setLdapGroupDisplayNameExpression
(String ldapGroupDisplayExtensionExpression1) JEXL expression language fragment that evaluates to the group display extension, optional for LDAP_GROUP_LIST or LDAP_GROUPS_FROM_ATTRIBUTESvoid
setLdapGroupNameExpression
(String ldapGroupNameExpression1) optional, for LDAP_GROUP_LIST, or LDAP_GROUPS_FROM_ATTRIBUTES JEXL expression language fragment that evaluates to the group name (relative in the stem as the group which has the loader definition)void
setLdapGroupOptins
(String ldapGroupOptins1) optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can OPTIN their group membershipvoid
setLdapGroupOptouts
(String ldapGroupOptouts1) optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can OPTOUT their group membershipvoid
setLdapGroupReaders
(String ldapGroupReaders1) optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can READ the group membershipsvoid
setLdapGroupUpdaters
(String ldapGroupUpdaters1) optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can UPDATE the group membershipsvoid
setLdapGroupViewers
(String ldapGroupViewers1) optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can VIEW the groupvoid
setLdapQuartzCron
(String ldapQuartzCron1) Quartz cron config string, e.g.void
setLdapResultsTransformationClass
(String ldapResultsTransformationClass1) optional for LDAP_GROUPS_FROM_ATTRIBUTES Class to transform data from ldap for more advanced transformations (e.g.void
setLdapSearchDn
(String ldapSearchDn1) Location that constrains the subtree where the filter is applicable.void
setLdapSearchScope
(String ldapSearchScope1) How the deep in the subtree the search will take place.void
setLdapServerId
(String ldapServerId1) Server ID that is configured in the grouper-loader.properties that identifies the connection information to the LDAP servervoid
setLdapSourceId
(String ldapSourceId1) Source ID from the subject.properties that narrows the search for subjects.void
setLdapSubjectAttribute
(String ldapSubjectAttribute1) Attribute name of the filter object result that holds the subject id.void
setLdapSubjectExpression
(String ldapSubjectExpression1) JEXL expression language fragment that processes the subject string before passing it to the subject APIvoid
setLdapSubjectIdType
(String ldapSubjectIdType1) The type of subject ID.void
setLdapType
(String ldapType1) extension of the attribute def name for type of ldap loader (e.g.void
query for this job (if runs against query)void
setStartTime
(long startTime1) start time of job
-
Field Details
-
FIELD_AND_GROUPS
constant for field name for: andGroups- See Also:
-
FIELD_ATTRIBUTE_DEF_NAME
constant for field name for: attributeDefName- See Also:
-
FIELD_ATTRIBUTE_LOADER_ACTION_QUERY
constant for field name for: attributeLoaderActionQuery- See Also:
-
FIELD_ATTRIBUTE_LOADER_ACTION_SET_QUERY
constant for field name for: attributeLoaderActionSetQuery- See Also:
-
FIELD_ATTRIBUTE_LOADER_ATTR_QUERY
constant for field name for: attributeLoaderAttrQuery- See Also:
-
FIELD_ATTRIBUTE_LOADER_ATTR_SET_QUERY
constant for field name for: attributeLoaderAttrSetQuery- See Also:
-
FIELD_ATTRIBUTE_LOADER_ATTRS_LIKE
constant for field name for: attributeLoaderAttrsLike- See Also:
-
FIELD_GROUP_LIKE_STRING
constant for field name for: groupLikeString- See Also:
-
FIELD_GROUP_NAME_OVERALL
constant for field name for: groupNameOverall- See Also:
-
FIELD_GROUP_QUERY
constant for field name for: groupQuery- See Also:
-
FIELD_GROUP_TYPES
constant for field name for: groupTypes- See Also:
-
FIELD_GROUPER_LOADER_DB
constant for field name for: grouperLoaderDb- See Also:
-
FIELD_GROUPER_LOADER_TYPE
constant for field name for: grouperLoaderType- See Also:
-
FIELD_GROUPER_SESSION
constant for field name for: grouperSession- See Also:
-
FIELD_HIB3_GROUPLOADER_LOG_OVERALL
constant for field name for: hib3GrouploaderLogOverall- See Also:
-
FIELD_LDAP_ATTRIBUTE_FILTER_EXPRESSION
constant for field name for: ldapAttributeFilterExpression- See Also:
-
FIELD_LDAP_EXTRA_ATTRIBUTES
constant for field name for: ldapExtraAttributes- See Also:
-
FIELD_LDAP_FILTER
constant for field name for: ldapFilter- See Also:
-
FIELD_LDAP_GROUP_ATTRIBUTE
constant for field name for: ldapGroupAttribute- See Also:
-
FIELD_LDAP_GROUP_DESCRIPTION_EXPRESSION
constant for field name for: ldapGroupDescriptionExpression- See Also:
-
FIELD_LDAP_GROUP_DISPLAY_EXTENSION_EXPRESSION
constant for field name for: ldapGroupDisplayExtensionExpression- See Also:
-
FIELD_LDAP_GROUP_NAME_EXPRESSION
constant for field name for: ldapGroupNameExpression- See Also:
-
FIELD_LDAP_QUARTZ_CRON
constant for field name for: ldapQuartzCron- See Also:
-
FIELD_LDAP_SEARCH_DN
constant for field name for: ldapSearchDn- See Also:
-
FIELD_LDAP_SEARCH_SCOPE
constant for field name for: ldapSearchScope- See Also:
-
FIELD_LDAP_SERVER_ID
constant for field name for: ldapServerId- See Also:
-
FIELD_LDAP_SOURCE_ID
constant for field name for: ldapSourceId- See Also:
-
FIELD_LDAP_SUBJECT_ATTRIBUTE
constant for field name for: ldapSubjectAttribute- See Also:
-
FIELD_LDAP_SUBJECT_EXPRESSION
constant for field name for: ldapSubjectExpression- See Also:
-
FIELD_LDAP_SUBJECT_ID_TYPE
constant for field name for: ldapSubjectIdType- See Also:
-
FIELD_LDAP_TYPE
constant for field name for: ldapType- See Also:
-
FIELD_QUERY
constant for field name for: query- See Also:
-
FIELD_START_TIME
constant for field name for: startTime- See Also:
-
-
Constructor Details
-
LoaderJobBean
public LoaderJobBean() -
LoaderJobBean
public LoaderJobBean(GrouperLoaderType grouperLoaderType1, String groupNameOverall1, GrouperLoaderDb grouperLoaderDb1, String query1, Hib3GrouperLoaderLog hib3GrouploaderLogOverall1, GrouperSession grouperSession1, List<Group> andGroups1, List<GroupType> groupTypes1, String groupLikeString1, String groupQuery1, long startTime1, GrouperLoaderDisplayNameSyncType grouperLoaderDisplayNameSyncType, String displayNameSyncBaseFolderName, Integer displayNameSyncLevels) - Parameters:
grouperLoaderType1
-groupNameOverall1
-grouperLoaderDb1
-query1
-hib3GrouploaderLogOverall1
-grouperSession1
-andGroups1
-groupTypes1
-groupLikeString1
- groups with this like DB sql string are managed by the loader. Any group in this list with no memberships and not in the group metadata query will be emptied and if configured deletedgroupQuery1
-startTime1
-grouperLoaderDisplayNameSyncType
-displayNameSyncBaseFolderName
-displayNameSyncLevels
-
-
LoaderJobBean
public LoaderJobBean(String ldapType1, String ldapServerId1, String ldapFilter1, String ldapSubjectAttribute1, String ldapSearchDn1, String ldapSourceId1, String ldapSubjectIdType1, String ldapSearchScope1, long startTime1, GrouperLoaderType grouperLoaderType1, String groupNameOverall1, Hib3GrouperLoaderLog hib3GrouploaderLogOverall1, GrouperSession grouperSession1, List<Group> andGroups1, String ldapGroupAttribute1, String extraAttributes1, String ldapGroupNameExpression1, String ldapGroupDisplayExtensionExpression1, String ldapGroupDescriptionExpression1, String ldapSubjectExpression1, List<GroupType> groupTypes1, String ldapGroupReaders1, String ldapGroupViewers1, String ldapGroupAdmins1, String ldapGroupUpdaters1, String ldapGroupOptins1, String ldapGroupOptouts1, String groupsLike1, String ldapAttributeFilterExpression1, String ldapGroupAttrReaders1, String ldapGroupAttrUpdaters1, String ldapResultsTransformationClass1) constructor for ldap jobs- Parameters:
ldapType1
-ldapServerId1
-ldapFilter1
-ldapSubjectAttribute1
-ldapSearchDn1
-ldapSourceId1
-ldapSubjectIdType1
-ldapSearchScope1
-startTime1
-grouperLoaderType1
-groupNameOverall1
-hib3GrouploaderLogOverall1
-grouperSession1
-andGroups1
-ldapGroupAttribute1
-extraAttributes1
-ldapGroupNameExpression1
-ldapGroupDisplayExtensionExpression1
-ldapGroupDescriptionExpression1
-ldapSubjectExpression1
-groupTypes1
-ldapGroupReaders1
-ldapGroupViewers1
-ldapGroupAdmins1
-ldapGroupUpdaters1
-ldapGroupOptins1
-ldapGroupOptouts1
-ldapAttributeFilterExpression1
-ldapGroupAttrReaders1
-ldapGroupAttrUpdaters1
-groupsLike1
-ldapResultsTransformationClass1
-
-
LoaderJobBean
public LoaderJobBean(GrouperLoaderType grouperLoaderType1, String attributeDefName, GrouperLoaderDb grouperLoaderDb1, Hib3GrouperLoaderLog hib3GrouploaderLogOverall1, GrouperSession grouperSession1, String attributeLoaderAttrQuery1, String attributeLoaderAttrSetQuery1, String attributeLoaderAttrsLike1, String attributeLoaderActionQuery1, String attributeLoaderActionSetQuery1, long startTime1) - Parameters:
grouperLoaderType1
-attributeDefName
-grouperLoaderDb1
-hib3GrouploaderLogOverall1
-grouperSession1
-startTime1
-attributeLoaderAttrQuery1
-attributeLoaderAttrSetQuery1
-attributeLoaderAttrsLike1
-attributeLoaderActionQuery1
-attributeLoaderActionSetQuery1
-
-
-
Method Details
-
getLdapType
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- Returns:
- type
-
setLdapType
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- Parameters:
ldapType1
-
-
getLdapExtraAttributes
Attribute names (comma separated) to get LDAP data for expressions in group name, displayExtension, description, optional, for LDAP_GROUP_LIST- Returns:
- the ldapExtraAttributes
-
setLdapExtraAttributes
Attribute names (comma separated) to get LDAP data for expressions in group name, displayExtension, description, optional, for LDAP_GROUP_LIST- Parameters:
ldapExtraAttributes1
- the ldapExtraAttributes to set
-
getLdapGroupOptouts
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can OPTOUT their group membership- Returns:
- optouts
-
getLdapGroupAttrReaders
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can GROUP_ATTR_READ- Returns:
- optouts
-
getLdapGroupAttrUpdaters
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can GROUP_ATTR_UPDATE- Returns:
- optouts
-
setLdapGroupOptouts
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can OPTOUT their group membership- Parameters:
ldapGroupOptouts1
-
-
setLdapGroupAttrReaders
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can GROUP_ATTR_READ- Parameters:
ldapGroupAttrReaders1
-
-
setLdapGroupAttrUpdate
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can GROUP_ATTR_UPDATE- Parameters:
ldapGroupAttrUpdaters1
-
-
getLdapGroupOptins
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can OPTIN their group membership- Returns:
- optins
-
setLdapGroupOptins
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can OPTIN their group membership- Parameters:
ldapGroupOptins1
-
-
getLdapGroupUpdaters
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can UPDATE the group memberships- Returns:
- updaters
-
setLdapGroupUpdaters
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can UPDATE the group memberships- Parameters:
ldapGroupUpdaters1
-
-
getLdapGroupAdmins
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can ADMIN the group- Returns:
- admins
-
setLdapGroupAdmins
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can ADMIN the group- Parameters:
ldapGroupAdmins1
-
-
getLdapGroupViewers
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can VIEW the group- Returns:
- viewers
-
setLdapGroupViewers
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can VIEW the group- Parameters:
ldapGroupViewers1
-
-
getLdapGroupReaders
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can READ the group memberships- Returns:
- readers
-
setLdapGroupReaders
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can READ the group memberships- Parameters:
ldapGroupReaders1
-
-
getLdapGroupNameExpression
optional, for LDAP_GROUP_LIST, or LDAP_GROUPS_FROM_ATTRIBUTES JEXL expression language fragment that evaluates to the group name (relative in the stem as the group which has the loader definition)- Returns:
- the ldapGroupNameExpression
-
setLdapGroupNameExpression
optional, for LDAP_GROUP_LIST, or LDAP_GROUPS_FROM_ATTRIBUTES JEXL expression language fragment that evaluates to the group name (relative in the stem as the group which has the loader definition)- Parameters:
ldapGroupNameExpression1
- the ldapGroupNameExpression to set
-
getLdapGroupDisplayNameExpression
JEXL expression language fragment that evaluates to the group display extension, optional for LDAP_GROUP_LIST or LDAP_GROUPS_FROM_ATTRIBUTES- Returns:
- the ldapGroupDisplayExtensionExpression
-
setLdapGroupDisplayNameExpression
JEXL expression language fragment that evaluates to the group display extension, optional for LDAP_GROUP_LIST or LDAP_GROUPS_FROM_ATTRIBUTES- Parameters:
ldapGroupDisplayExtensionExpression1
- the ldapGroupDisplayExtensionExpression to set
-
getLdapGroupDescriptionExpression
JEXL expression language fragment that evaluates to the group description, optional for LDAP_GROUP_LIST or LDAP_GROUPS_FROM_ATTRIBUTES- Returns:
- the ldapGroupDescriptionExpression
-
setLdapGroupDescriptionExpression
JEXL expression language fragment that evaluates to the group description, optional for LDAP_GROUP_LIST or LDAP_GROUPS_FROM_ATTRIBUTES- Parameters:
ldapGroupDescriptionExpression1
- the ldapGroupDescriptionExpression to set
-
getLdapAttributeFilterExpression
if filtering which attributes, this is the jexl expression- Returns:
- ldap attribute filter expression
-
setLdapAttributeFilterExpression
if filtering which attributes, this is the jexl expression- Parameters:
ldapAttributeFilterExpression1
-
-
getLdapSubjectExpression
JEXL expression language fragment that processes the subject string before passing it to the subject API- Returns:
- the ldapSubjectExpression
-
setLdapSubjectExpression
JEXL expression language fragment that processes the subject string before passing it to the subject API- Parameters:
ldapSubjectExpression1
- the ldapSubjectExpression to set
-
getLdapGroupAttribute
required for LDAP_GROUPS_FROM_ATTRIBUTES Attribute name of the filter object result that holds the group name- Returns:
- the ldapGroupAttribute
-
setLdapGroupAttribute
required for LDAP_GROUPS_FROM_ATTRIBUTES Attribute name of the filter object result that holds the group name- Parameters:
ldapGroupAttribute1
- the ldapGroupAttribute to set
-
getLdapServerId
Server ID that is configured in the grouper-loader.properties that identifies the connection information to the LDAP server- Returns:
- server id
-
setLdapServerId
Server ID that is configured in the grouper-loader.properties that identifies the connection information to the LDAP server- Parameters:
ldapServerId1
-
-
getLdapFilter
LDAP filter returns objects that have subjectIds or subjectIdentifiers and group name (if LDAP_GROUP_LIST)- Returns:
- filter
-
setLdapFilter
LDAP filter returns objects that have subjectIds or subjectIdentifiers and group name (if LDAP_GROUP_LIST)- Parameters:
ldapFilter1
-
-
getLdapSubjectAttribute
Attribute name of the filter object result that holds the subject id.- Returns:
- attribute name
-
setLdapSubjectAttribute
Attribute name of the filter object result that holds the subject id.- Parameters:
ldapSubjectAttribute1
-
-
getLdapSearchDn
Location that constrains the subtree where the filter is applicable. Note, this is relative to the base DN in the ldap server config in the grouper-loader.properties for this server. This makes the query more efficient- Returns:
- search dn
-
setLdapSearchDn
Location that constrains the subtree where the filter is applicable. Note, this is relative to the base DN in the ldap server config in the grouper-loader.properties for this server. This makes the query more efficient- Parameters:
ldapSearchDn1
-
-
getLdapQuartzCron
Quartz cron config string, e.g. every day at 8am is: 0 0 8 * * ?- Returns:
- quartz cron
-
setLdapQuartzCron
Quartz cron config string, e.g. every day at 8am is: 0 0 8 * * ?- Parameters:
ldapQuartzCron1
-
-
getLdapSourceId
Source ID from the subject.properties that narrows the search for subjects. This is optional though makes the loader job more efficient- Returns:
- source id
-
setLdapSourceId
Source ID from the subject.properties that narrows the search for subjects. This is optional though makes the loader job more efficient- Parameters:
ldapSourceId1
-
-
getLdapSubjectIdType
The type of subject ID. This can be either: subjectId (most efficient, default), subjectIdentifier (2nd most efficient), or subjectIdOrIdentifier- Returns:
- subject id type
-
setLdapSubjectIdType
The type of subject ID. This can be either: subjectId (most efficient, default), subjectIdentifier (2nd most efficient), or subjectIdOrIdentifier- Parameters:
ldapSubjectIdType1
-
-
getLdapSearchScope
How the deep in the subtree the search will take place. Can be OBJECT_SCOPE, ONELEVEL_SCOPE, or SUBTREE_SCOPE (default)- Returns:
- search scope
-
setLdapSearchScope
How the deep in the subtree the search will take place. Can be OBJECT_SCOPE, ONELEVEL_SCOPE, or SUBTREE_SCOPE (default)- Parameters:
ldapSearchScope1
-
-
getAttributeDefName
attributeDef name for the job- Returns:
- attributeDef name
-
setAttributeDefName
attributeDef name for the job- Parameters:
attributeDefName1
-
-
getAttributeLoaderActionQuery
SQL query with at least the following column: action_name- Returns:
- query
-
setAttributeLoaderActionQuery
SQL query with at least the following column: action_name- Parameters:
attributeLoaderActionQuery1
-
-
getAttributeLoaderActionSetQuery
SQL query with at least the following columns: if_has_action_name, then_has_action_name- Returns:
- query
-
setAttributeLoaderActionSetQuery
SQL query with at least the following columns: if_has_action_name, then_has_action_name- Parameters:
attributeLoaderActionSetQuery1
-
-
getAttributeLoaderAttrsLike
If empty, then orphans will be left alone (for attributeDefName and attributeDefNameSets). If %, then all orphans deleted. If a SQL like string, then only ones in that like string not in loader will be deleted- Returns:
- attrs like
-
setAttributeLoaderAttrsLike
If empty, then orphans will be left alone (for attributeDefName and attributeDefNameSets). If %, then all orphans deleted. If a SQL like string, then only ones in that like string not in loader will be deleted- Parameters:
attributeLoaderAttrsLike1
-
-
getAttributeLoaderAttrQuery
SQL query with at least some of the following columns: attr_name, attr_display_name, attr_description- Returns:
- query
-
setAttributeLoaderAttrQuery
SQL query with at least some of the following columns: attr_name, attr_display_name, attr_description- Parameters:
attributeLoaderAttrQuery1
-
-
getAttributeLoaderAttrSetQuery
SQL query with at least the following columns: if_has_attr_name, then_has_attr_name- Returns:
- sql query
-
setAttributeLoaderAttrSetQuery
SQL query with at least the following columns: if_has_attr_name, then_has_attr_name- Parameters:
attributeLoaderAttrSetQuery1
-
-
clone
deep clone the fields in this object -
getGrouperLoaderType
type of job, e.g. group list, or sql simple- Returns:
- type
-
getGroupNameOverall
overall group name (if a group list job, then overall, if sql simple, then the group)- Returns:
- group name overall
-
getGrouperLoaderDb
database this runs against- Returns:
- loader db
-
getQuery
query for the job- Returns:
- query
-
getHib3GrouploaderLogOverall
log entry for the job- Returns:
- log
-
getGrouperSession
grouper session (probably a root session)- Returns:
- session
-
getAndGroups
members must be in these groups also to be in the overall group- Returns:
- and groups
-
getGroupTypes
group types to add to loader managed group- Returns:
- group types
-
getGroupLikeString
- Returns:
- group like string
-
getGroupQuery
group query- Returns:
- group query
-
getGrouperLoaderDisplayNameSyncType
-
getDisplayNameSyncBaseFolderName
-
getDisplayNameSyncLevels
-
setGrouperLoaderType
type of job, e.g. sql simple or group list- Parameters:
grouperLoaderType
-
-
setGroupNameOverall
group name for job (if group list, this is the overall name)- Parameters:
groupNameOverall
-
-
setGrouperLoaderDb
db this job runs against- Parameters:
grouperLoaderDb
-
-
setQuery
query for this job (if runs against query)- Parameters:
query1
-
-
setHib3GrouploaderLogOverall
- Parameters:
hib3GrouploaderLogOverall1
-
-
setGrouperSession
grouper session, probably a root session- Parameters:
grouperSession1
-
-
setAndGroups
members must be in these groups also to be in the overall group- Parameters:
andGroups1
-
-
setGroupTypes
group types to add to loader managed group- Parameters:
groupTypes
-
-
setGroupLikeString
groups with this like DB sql string are managed by the loader. Any group in this list with no memberships and not in the group metadata query will be emptied and if configured deleted- Parameters:
groupLikeString
-
-
setGroupQuery
- Parameters:
groupQuery1
-
-
getStartTime
public long getStartTime()start time of job- Returns:
- start time
-
setStartTime
public void setStartTime(long startTime1) start time of job- Parameters:
startTime1
-
-
getLdapResultsTransformationClass
optional for LDAP_GROUPS_FROM_ATTRIBUTES Class to transform data from ldap for more advanced transformations (e.g. parsing ldap attribute values into multiple groups)- Returns:
- the ldapResultsTransformationClass
-
setLdapResultsTransformationClass
optional for LDAP_GROUPS_FROM_ATTRIBUTES Class to transform data from ldap for more advanced transformations (e.g. parsing ldap attribute values into multiple groups)- Parameters:
ldapResultsTransformationClass1
- the ldapResultsTransformationClass1 to set
-
setGrouperFailsafeBean
failsafe settings, defaults, etc- Parameters:
grouperFailsafeBean1
-
-
getGrouperFailsafeBean
failsafe settings, defaults, etc- Returns:
-