edu.internet2.middleware.grouper.app.loader
Class LoaderJobBean

java.lang.Object
  extended by edu.internet2.middleware.grouper.app.loader.LoaderJobBean

public class LoaderJobBean
extends Object

bean to hold objects for loader job


Field Summary
static String FIELD_AND_GROUPS
          constant for field name for: andGroups
static String FIELD_ATTRIBUTE_DEF_NAME
          constant for field name for: attributeDefName
static String FIELD_ATTRIBUTE_LOADER_ACTION_QUERY
          constant for field name for: attributeLoaderActionQuery
static String FIELD_ATTRIBUTE_LOADER_ACTION_SET_QUERY
          constant for field name for: attributeLoaderActionSetQuery
static String FIELD_ATTRIBUTE_LOADER_ATTR_QUERY
          constant for field name for: attributeLoaderAttrQuery
static String FIELD_ATTRIBUTE_LOADER_ATTR_SET_QUERY
          constant for field name for: attributeLoaderAttrSetQuery
static String FIELD_ATTRIBUTE_LOADER_ATTRS_LIKE
          constant for field name for: attributeLoaderAttrsLike
static String FIELD_GROUP_LIKE_STRING
          constant for field name for: groupLikeString
static String FIELD_GROUP_NAME_OVERALL
          constant for field name for: groupNameOverall
static String FIELD_GROUP_QUERY
          constant for field name for: groupQuery
static String FIELD_GROUP_TYPES
          constant for field name for: groupTypes
static String FIELD_GROUPER_LOADER_DB
          constant for field name for: grouperLoaderDb
static String FIELD_GROUPER_LOADER_TYPE
          constant for field name for: grouperLoaderType
static String FIELD_GROUPER_SESSION
          constant for field name for: grouperSession
static String FIELD_HIB3_GROUPLOADER_LOG_OVERALL
          constant for field name for: hib3GrouploaderLogOverall
static String FIELD_LDAP_ATTRIBUTE_FILTER_EXPRESSION
          constant for field name for: ldapAttributeFilterExpression
static String FIELD_LDAP_EXTRA_ATTRIBUTES
          constant for field name for: ldapExtraAttributes
static String FIELD_LDAP_FILTER
          constant for field name for: ldapFilter
static String FIELD_LDAP_GROUP_ATTRIBUTE
          constant for field name for: ldapGroupAttribute
static String FIELD_LDAP_GROUP_DESCRIPTION_EXPRESSION
          constant for field name for: ldapGroupDescriptionExpression
static String FIELD_LDAP_GROUP_DISPLAY_EXTENSION_EXPRESSION
          constant for field name for: ldapGroupDisplayExtensionExpression
static String FIELD_LDAP_GROUP_NAME_EXPRESSION
          constant for field name for: ldapGroupNameExpression
static String FIELD_LDAP_QUARTZ_CRON
          constant for field name for: ldapQuartzCron
static String FIELD_LDAP_SEARCH_DN
          constant for field name for: ldapSearchDn
static String FIELD_LDAP_SEARCH_SCOPE
          constant for field name for: ldapSearchScope
static String FIELD_LDAP_SERVER_ID
          constant for field name for: ldapServerId
static String FIELD_LDAP_SOURCE_ID
          constant for field name for: ldapSourceId
static String FIELD_LDAP_SUBJECT_ATTRIBUTE
          constant for field name for: ldapSubjectAttribute
static String FIELD_LDAP_SUBJECT_EXPRESSION
          constant for field name for: ldapSubjectExpression
static String FIELD_LDAP_SUBJECT_ID_TYPE
          constant for field name for: ldapSubjectIdType
static String FIELD_LDAP_TYPE
          constant for field name for: ldapType
static String FIELD_QUERY
          constant for field name for: query
static String FIELD_START_TIME
          constant for field name for: startTime
 
Constructor Summary
LoaderJobBean()
           
LoaderJobBean(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)
           
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)
          constructor for ldap jobs
 
Method Summary
 LoaderJobBean clone()
          deep clone the fields in this object
 List<Group> getAndGroups()
          members must be in these groups also to be in the overall group
 String getAttributeDefName()
          attributeDef name for the job
 String getAttributeLoaderActionQuery()
          SQL query with at least the following column: action_name
 String getAttributeLoaderActionSetQuery()
          SQL query with at least the following columns: if_has_action_name, then_has_action_name
 String getAttributeLoaderAttrQuery()
          SQL query with at least some of the following columns: attr_name, attr_display_name, attr_description
 String getAttributeLoaderAttrSetQuery()
          SQL query with at least the following columns: if_has_attr_name, then_has_attr_name
 String getAttributeLoaderAttrsLike()
          If empty, then orphans will be left alone (for attributeDefName and attributeDefNameSets).
 GrouperLoaderDb getGrouperLoaderDb()
          database this runs against
 GrouperLoaderType getGrouperLoaderType()
          type of job, e.g.
 GrouperSession getGrouperSession()
          grouper session (probably a root session)
 String getGroupLikeString()
           
 String getGroupNameOverall()
          overall group name (if a group list job, then overall, if sql simple, then the group)
 String getGroupQuery()
          group query
 List<GroupType> getGroupTypes()
          group types to add to loader managed group
 Hib3GrouperLoaderLog getHib3GrouploaderLogOverall()
          log entry for the job
 String getLdapAttributeFilterExpression()
          if filtering which attributes, this is the jexl expression
 String getLdapExtraAttributes()
          Attribute names (comma separated) to get LDAP data for expressions in group name, displayExtension, description, optional, for LDAP_GROUP_LIST
 String getLdapFilter()
          LDAP filter returns objects that have subjectIds or subjectIdentifiers and group name (if LDAP_GROUP_LIST)
 String getLdapGroupAdmins()
          optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can ADMIN the group
 String getLdapGroupAttribute()
          required for LDAP_GROUPS_FROM_ATTRIBUTES Attribute name of the filter object result that holds the group name
 String getLdapGroupAttrReaders()
          optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can GROUP_ATTR_READ
 String getLdapGroupAttrUpdaters()
          optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can GROUP_ATTR_UPDATE
 String getLdapGroupDescriptionExpression()
          JEXL expression language fragment that evaluates to the group description, optional for LDAP_GROUP_LIST or LDAP_GROUPS_FROM_ATTRIBUTES
 String getLdapGroupDisplayNameExpression()
          JEXL expression language fragment that evaluates to the group display extension, optional for LDAP_GROUP_LIST or LDAP_GROUPS_FROM_ATTRIBUTES
 String 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)
 String getLdapGroupOptins()
          optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can OPTIN their group membership
 String getLdapGroupOptouts()
          optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can OPTOUT their group membership
 String getLdapGroupReaders()
          optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can READ the group memberships
 String getLdapGroupUpdaters()
          optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can UPDATE the group memberships
 String getLdapGroupViewers()
          optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can VIEW the group
 String getLdapQuartzCron()
          Quartz cron config string, e.g.
 String getLdapSearchDn()
          Location that constrains the subtree where the filter is applicable.
 String getLdapSearchScope()
          How the deep in the subtree the search will take place.
 String getLdapServerId()
          Server ID that is configured in the grouper-loader.properties that identifies the connection information to the LDAP server
 String getLdapSourceId()
          Source ID from the sources.xml that narrows the search for subjects.
 String getLdapSubjectAttribute()
          Attribute name of the filter object result that holds the subject id.
 String getLdapSubjectExpression()
          JEXL expression language fragment that processes the subject string before passing it to the subject API
 String getLdapSubjectIdType()
          The type of subject ID.
 String getLdapType()
          extension of the attribute def name for type of ldap loader (e.g.
 String getQuery()
          query for the job
 long getStartTime()
          start time of job
 void setAndGroups(List<Group> andGroups1)
          members must be in these groups also to be in the overall group
 void setAttributeDefName(String attributeDefName1)
          attributeDef name for the job
 void setAttributeLoaderActionQuery(String attributeLoaderActionQuery1)
          SQL query with at least the following column: action_name
 void setAttributeLoaderActionSetQuery(String attributeLoaderActionSetQuery1)
          SQL query with at least the following columns: if_has_action_name, then_has_action_name
 void setAttributeLoaderAttrQuery(String attributeLoaderAttrQuery1)
          SQL query with at least some of the following columns: attr_name, attr_display_name, attr_description
 void setAttributeLoaderAttrSetQuery(String attributeLoaderAttrSetQuery1)
          SQL query with at least the following columns: if_has_attr_name, then_has_attr_name
 void setAttributeLoaderAttrsLike(String attributeLoaderAttrsLike1)
          If empty, then orphans will be left alone (for attributeDefName and attributeDefNameSets).
 void setGrouperLoaderDb(GrouperLoaderDb grouperLoaderDb)
          db this job runs against
 void setGrouperLoaderType(GrouperLoaderType grouperLoaderType)
          type of job, e.g.
 void setGrouperSession(GrouperSession grouperSession1)
          grouper session, probably a root session
 void 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 group
 void setHib3GrouploaderLogOverall(Hib3GrouperLoaderLog hib3GrouploaderLogOverall1)
           
 void setLdapAttributeFilterExpression(String ldapAttributeFilterExpression1)
          if filtering which attributes, this is the jexl expression
 void setLdapExtraAttributes(String ldapExtraAttributes1)
          Attribute names (comma separated) to get LDAP data for expressions in group name, displayExtension, description, optional, for LDAP_GROUP_LIST
 void 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 group
 void setLdapGroupAttribute(String ldapGroupAttribute1)
          required for LDAP_GROUPS_FROM_ATTRIBUTES Attribute name of the filter object result that holds the group name
 void setLdapGroupAttrReaders(String ldapGroupAttrReaders1)
          optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can GROUP_ATTR_READ
 void setLdapGroupAttrUpdate(String ldapGroupAttrUpdaters1)
          optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can GROUP_ATTR_UPDATE
 void setLdapGroupDescriptionExpression(String ldapGroupDescriptionExpression1)
          JEXL expression language fragment that evaluates to the group description, optional for LDAP_GROUP_LIST or LDAP_GROUPS_FROM_ATTRIBUTES
 void setLdapGroupDisplayNameExpression(String ldapGroupDisplayExtensionExpression1)
          JEXL expression language fragment that evaluates to the group display extension, optional for LDAP_GROUP_LIST or LDAP_GROUPS_FROM_ATTRIBUTES
 void 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 membership
 void setLdapGroupOptouts(String ldapGroupOptouts1)
          optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can OPTOUT their group membership
 void setLdapGroupReaders(String ldapGroupReaders1)
          optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can READ the group memberships
 void setLdapGroupUpdaters(String ldapGroupUpdaters1)
          optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can UPDATE the group memberships
 void setLdapGroupViewers(String ldapGroupViewers1)
          optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can VIEW the group
 void setLdapQuartzCron(String ldapQuartzCron1)
          Quartz cron config string, 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 server
 void setLdapSourceId(String ldapSourceId1)
          Source ID from the sources.xml 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 API
 void 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 setQuery(String query1)
          query for this job (if runs against query)
 void setStartTime(long startTime1)
          start time of job
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

FIELD_AND_GROUPS

public static final String FIELD_AND_GROUPS
constant for field name for: andGroups

See Also:
Constant Field Values

FIELD_ATTRIBUTE_DEF_NAME

public static final String FIELD_ATTRIBUTE_DEF_NAME
constant for field name for: attributeDefName

See Also:
Constant Field Values

FIELD_ATTRIBUTE_LOADER_ACTION_QUERY

public static final String FIELD_ATTRIBUTE_LOADER_ACTION_QUERY
constant for field name for: attributeLoaderActionQuery

See Also:
Constant Field Values

FIELD_ATTRIBUTE_LOADER_ACTION_SET_QUERY

public static final String FIELD_ATTRIBUTE_LOADER_ACTION_SET_QUERY
constant for field name for: attributeLoaderActionSetQuery

See Also:
Constant Field Values

FIELD_ATTRIBUTE_LOADER_ATTR_QUERY

public static final String FIELD_ATTRIBUTE_LOADER_ATTR_QUERY
constant for field name for: attributeLoaderAttrQuery

See Also:
Constant Field Values

FIELD_ATTRIBUTE_LOADER_ATTR_SET_QUERY

public static final String FIELD_ATTRIBUTE_LOADER_ATTR_SET_QUERY
constant for field name for: attributeLoaderAttrSetQuery

See Also:
Constant Field Values

FIELD_ATTRIBUTE_LOADER_ATTRS_LIKE

public static final String FIELD_ATTRIBUTE_LOADER_ATTRS_LIKE
constant for field name for: attributeLoaderAttrsLike

See Also:
Constant Field Values

FIELD_GROUP_LIKE_STRING

public static final String FIELD_GROUP_LIKE_STRING
constant for field name for: groupLikeString

See Also:
Constant Field Values

FIELD_GROUP_NAME_OVERALL

public static final String FIELD_GROUP_NAME_OVERALL
constant for field name for: groupNameOverall

See Also:
Constant Field Values

FIELD_GROUP_QUERY

public static final String FIELD_GROUP_QUERY
constant for field name for: groupQuery

See Also:
Constant Field Values

FIELD_GROUP_TYPES

public static final String FIELD_GROUP_TYPES
constant for field name for: groupTypes

See Also:
Constant Field Values

FIELD_GROUPER_LOADER_DB

public static final String FIELD_GROUPER_LOADER_DB
constant for field name for: grouperLoaderDb

See Also:
Constant Field Values

FIELD_GROUPER_LOADER_TYPE

public static final String FIELD_GROUPER_LOADER_TYPE
constant for field name for: grouperLoaderType

See Also:
Constant Field Values

FIELD_GROUPER_SESSION

public static final String FIELD_GROUPER_SESSION
constant for field name for: grouperSession

See Also:
Constant Field Values

FIELD_HIB3_GROUPLOADER_LOG_OVERALL

public static final String FIELD_HIB3_GROUPLOADER_LOG_OVERALL
constant for field name for: hib3GrouploaderLogOverall

See Also:
Constant Field Values

FIELD_LDAP_ATTRIBUTE_FILTER_EXPRESSION

public static final String FIELD_LDAP_ATTRIBUTE_FILTER_EXPRESSION
constant for field name for: ldapAttributeFilterExpression

See Also:
Constant Field Values

FIELD_LDAP_EXTRA_ATTRIBUTES

public static final String FIELD_LDAP_EXTRA_ATTRIBUTES
constant for field name for: ldapExtraAttributes

See Also:
Constant Field Values

FIELD_LDAP_FILTER

public static final String FIELD_LDAP_FILTER
constant for field name for: ldapFilter

See Also:
Constant Field Values

FIELD_LDAP_GROUP_ATTRIBUTE

public static final String FIELD_LDAP_GROUP_ATTRIBUTE
constant for field name for: ldapGroupAttribute

See Also:
Constant Field Values

FIELD_LDAP_GROUP_DESCRIPTION_EXPRESSION

public static final String FIELD_LDAP_GROUP_DESCRIPTION_EXPRESSION
constant for field name for: ldapGroupDescriptionExpression

See Also:
Constant Field Values

FIELD_LDAP_GROUP_DISPLAY_EXTENSION_EXPRESSION

public static final String FIELD_LDAP_GROUP_DISPLAY_EXTENSION_EXPRESSION
constant for field name for: ldapGroupDisplayExtensionExpression

See Also:
Constant Field Values

FIELD_LDAP_GROUP_NAME_EXPRESSION

public static final String FIELD_LDAP_GROUP_NAME_EXPRESSION
constant for field name for: ldapGroupNameExpression

See Also:
Constant Field Values

FIELD_LDAP_QUARTZ_CRON

public static final String FIELD_LDAP_QUARTZ_CRON
constant for field name for: ldapQuartzCron

See Also:
Constant Field Values

FIELD_LDAP_SEARCH_DN

public static final String FIELD_LDAP_SEARCH_DN
constant for field name for: ldapSearchDn

See Also:
Constant Field Values

FIELD_LDAP_SEARCH_SCOPE

public static final String FIELD_LDAP_SEARCH_SCOPE
constant for field name for: ldapSearchScope

See Also:
Constant Field Values

FIELD_LDAP_SERVER_ID

public static final String FIELD_LDAP_SERVER_ID
constant for field name for: ldapServerId

See Also:
Constant Field Values

FIELD_LDAP_SOURCE_ID

public static final String FIELD_LDAP_SOURCE_ID
constant for field name for: ldapSourceId

See Also:
Constant Field Values

FIELD_LDAP_SUBJECT_ATTRIBUTE

public static final String FIELD_LDAP_SUBJECT_ATTRIBUTE
constant for field name for: ldapSubjectAttribute

See Also:
Constant Field Values

FIELD_LDAP_SUBJECT_EXPRESSION

public static final String FIELD_LDAP_SUBJECT_EXPRESSION
constant for field name for: ldapSubjectExpression

See Also:
Constant Field Values

FIELD_LDAP_SUBJECT_ID_TYPE

public static final String FIELD_LDAP_SUBJECT_ID_TYPE
constant for field name for: ldapSubjectIdType

See Also:
Constant Field Values

FIELD_LDAP_TYPE

public static final String FIELD_LDAP_TYPE
constant for field name for: ldapType

See Also:
Constant Field Values

FIELD_QUERY

public static final String FIELD_QUERY
constant for field name for: query

See Also:
Constant Field Values

FIELD_START_TIME

public static final String FIELD_START_TIME
constant for field name for: startTime

See Also:
Constant Field Values
Constructor Detail

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)
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 deleted
groupQuery1 -
startTime1 -

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)
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 -

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 Detail

getLdapType

public String 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

public void setLdapType(String ldapType1)
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

public String 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

public void setLdapExtraAttributes(String ldapExtraAttributes1)
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

public String 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

public String 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

public String 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

public void setLdapGroupOptouts(String ldapGroupOptouts1)
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

public void setLdapGroupAttrReaders(String ldapGroupAttrReaders1)
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can GROUP_ATTR_READ

Parameters:
ldapGroupAttrReaders1 -

setLdapGroupAttrUpdate

public void setLdapGroupAttrUpdate(String ldapGroupAttrUpdaters1)
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can GROUP_ATTR_UPDATE

Parameters:
ldapGroupAttrUpdaters1 -

getLdapGroupOptins

public String 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

public 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 membership

Parameters:
ldapGroupOptins1 -

getLdapGroupUpdaters

public String 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

public void setLdapGroupUpdaters(String ldapGroupUpdaters1)
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

public String 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

public void setLdapGroupAdmins(String ldapGroupAdmins1)
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can ADMIN the group

Parameters:
ldapGroupAdmins1 -

getLdapGroupViewers

public String 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

public void setLdapGroupViewers(String ldapGroupViewers1)
optional for LDAP_GROUPS_FROM_ATTRIBUTES, LDAP_GROUP_LIST Comma separated list of subjectIds or subjectIdentifiers who can VIEW the group

Parameters:
ldapGroupViewers1 -

getLdapGroupReaders

public String 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

public void setLdapGroupReaders(String ldapGroupReaders1)
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

public String 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

public void 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)

Parameters:
ldapGroupNameExpression1 - the ldapGroupNameExpression to set

getLdapGroupDisplayNameExpression

public String 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

public void setLdapGroupDisplayNameExpression(String ldapGroupDisplayExtensionExpression1)
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

public String 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

public void setLdapGroupDescriptionExpression(String ldapGroupDescriptionExpression1)
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

public String getLdapAttributeFilterExpression()
if filtering which attributes, this is the jexl expression

Returns:
ldap attribute filter expression

setLdapAttributeFilterExpression

public void setLdapAttributeFilterExpression(String ldapAttributeFilterExpression1)
if filtering which attributes, this is the jexl expression

Parameters:
ldapAttributeFilterExpression1 -

getLdapSubjectExpression

public String getLdapSubjectExpression()
JEXL expression language fragment that processes the subject string before passing it to the subject API

Returns:
the ldapSubjectExpression

setLdapSubjectExpression

public void setLdapSubjectExpression(String ldapSubjectExpression1)
JEXL expression language fragment that processes the subject string before passing it to the subject API

Parameters:
ldapSubjectExpression1 - the ldapSubjectExpression to set

getLdapGroupAttribute

public String getLdapGroupAttribute()
required for LDAP_GROUPS_FROM_ATTRIBUTES Attribute name of the filter object result that holds the group name

Returns:
the ldapGroupAttribute

setLdapGroupAttribute

public void setLdapGroupAttribute(String ldapGroupAttribute1)
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

public String getLdapServerId()
Server ID that is configured in the grouper-loader.properties that identifies the connection information to the LDAP server

Returns:
server id

setLdapServerId

public void setLdapServerId(String ldapServerId1)
Server ID that is configured in the grouper-loader.properties that identifies the connection information to the LDAP server

Parameters:
ldapServerId1 -

getLdapFilter

public String getLdapFilter()
LDAP filter returns objects that have subjectIds or subjectIdentifiers and group name (if LDAP_GROUP_LIST)

Returns:
filter

setLdapFilter

public void setLdapFilter(String ldapFilter1)
LDAP filter returns objects that have subjectIds or subjectIdentifiers and group name (if LDAP_GROUP_LIST)

Parameters:
ldapFilter1 -

getLdapSubjectAttribute

public String getLdapSubjectAttribute()
Attribute name of the filter object result that holds the subject id.

Returns:
attribute name

setLdapSubjectAttribute

public void setLdapSubjectAttribute(String ldapSubjectAttribute1)
Attribute name of the filter object result that holds the subject id.

Parameters:
ldapSubjectAttribute1 -

getLdapSearchDn

public String 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

public void setLdapSearchDn(String ldapSearchDn1)
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

public String getLdapQuartzCron()
Quartz cron config string, e.g. every day at 8am is: 0 0 8 * * ?

Returns:
quartz cron

setLdapQuartzCron

public void setLdapQuartzCron(String ldapQuartzCron1)
Quartz cron config string, e.g. every day at 8am is: 0 0 8 * * ?

Parameters:
ldapQuartzCron1 -

getLdapSourceId

public String getLdapSourceId()
Source ID from the sources.xml that narrows the search for subjects. This is optional though makes the loader job more efficient

Returns:
source id

setLdapSourceId

public void setLdapSourceId(String ldapSourceId1)
Source ID from the sources.xml that narrows the search for subjects. This is optional though makes the loader job more efficient

Parameters:
ldapSourceId1 -

getLdapSubjectIdType

public String 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

public void setLdapSubjectIdType(String ldapSubjectIdType1)
The type of subject ID. This can be either: subjectId (most efficient, default), subjectIdentifier (2nd most efficient), or subjectIdOrIdentifier

Parameters:
ldapSubjectIdType1 -

getLdapSearchScope

public String 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

public void setLdapSearchScope(String ldapSearchScope1)
How the deep in the subtree the search will take place. Can be OBJECT_SCOPE, ONELEVEL_SCOPE, or SUBTREE_SCOPE (default)

Parameters:
ldapSearchScope1 -

getAttributeDefName

public String getAttributeDefName()
attributeDef name for the job

Returns:
attributeDef name

setAttributeDefName

public void setAttributeDefName(String attributeDefName1)
attributeDef name for the job

Parameters:
attributeDefName1 -

getAttributeLoaderActionQuery

public String getAttributeLoaderActionQuery()
SQL query with at least the following column: action_name

Returns:
query

setAttributeLoaderActionQuery

public void setAttributeLoaderActionQuery(String attributeLoaderActionQuery1)
SQL query with at least the following column: action_name

Parameters:
attributeLoaderActionQuery1 -

getAttributeLoaderActionSetQuery

public String getAttributeLoaderActionSetQuery()
SQL query with at least the following columns: if_has_action_name, then_has_action_name

Returns:
query

setAttributeLoaderActionSetQuery

public void setAttributeLoaderActionSetQuery(String attributeLoaderActionSetQuery1)
SQL query with at least the following columns: if_has_action_name, then_has_action_name

Parameters:
attributeLoaderActionSetQuery1 -

getAttributeLoaderAttrsLike

public String 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

public void setAttributeLoaderAttrsLike(String attributeLoaderAttrsLike1)
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

public String getAttributeLoaderAttrQuery()
SQL query with at least some of the following columns: attr_name, attr_display_name, attr_description

Returns:
query

setAttributeLoaderAttrQuery

public void setAttributeLoaderAttrQuery(String attributeLoaderAttrQuery1)
SQL query with at least some of the following columns: attr_name, attr_display_name, attr_description

Parameters:
attributeLoaderAttrQuery1 -

getAttributeLoaderAttrSetQuery

public String getAttributeLoaderAttrSetQuery()
SQL query with at least the following columns: if_has_attr_name, then_has_attr_name

Returns:
sql query

setAttributeLoaderAttrSetQuery

public void setAttributeLoaderAttrSetQuery(String attributeLoaderAttrSetQuery1)
SQL query with at least the following columns: if_has_attr_name, then_has_attr_name

Parameters:
attributeLoaderAttrSetQuery1 -

clone

public LoaderJobBean clone()
deep clone the fields in this object

Overrides:
clone in class Object

getGrouperLoaderType

public GrouperLoaderType getGrouperLoaderType()
type of job, e.g. group list, or sql simple

Returns:
type

getGroupNameOverall

public String getGroupNameOverall()
overall group name (if a group list job, then overall, if sql simple, then the group)

Returns:
group name overall

getGrouperLoaderDb

public GrouperLoaderDb getGrouperLoaderDb()
database this runs against

Returns:
loader db

getQuery

public String getQuery()
query for the job

Returns:
query

getHib3GrouploaderLogOverall

public Hib3GrouperLoaderLog getHib3GrouploaderLogOverall()
log entry for the job

Returns:
log

getGrouperSession

public GrouperSession getGrouperSession()
grouper session (probably a root session)

Returns:
session

getAndGroups

public List<Group> getAndGroups()
members must be in these groups also to be in the overall group

Returns:
and groups

getGroupTypes

public List<GroupType> getGroupTypes()
group types to add to loader managed group

Returns:
group types

getGroupLikeString

public String getGroupLikeString()
Returns:
group like string

getGroupQuery

public String getGroupQuery()
group query

Returns:
group query

setGrouperLoaderType

public void setGrouperLoaderType(GrouperLoaderType grouperLoaderType)
type of job, e.g. sql simple or group list

Parameters:
grouperLoaderType -

setGroupNameOverall

public void setGroupNameOverall(String groupNameOverall)
group name for job (if group list, this is the overall name)

Parameters:
groupNameOverall -

setGrouperLoaderDb

public void setGrouperLoaderDb(GrouperLoaderDb grouperLoaderDb)
db this job runs against

Parameters:
grouperLoaderDb -

setQuery

public void setQuery(String query1)
query for this job (if runs against query)

Parameters:
query1 -

setHib3GrouploaderLogOverall

public void setHib3GrouploaderLogOverall(Hib3GrouperLoaderLog hib3GrouploaderLogOverall1)
Parameters:
hib3GrouploaderLogOverall1 -

setGrouperSession

public void setGrouperSession(GrouperSession grouperSession1)
grouper session, probably a root session

Parameters:
grouperSession1 -

setAndGroups

public void setAndGroups(List<Group> andGroups1)
members must be in these groups also to be in the overall group

Parameters:
andGroups1 -

setGroupTypes

public void setGroupTypes(List<GroupType> groupTypes)
group types to add to loader managed group

Parameters:
groupTypes -

setGroupLikeString

public void setGroupLikeString(String groupLikeString)
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

public void setGroupQuery(String groupQuery1)
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 -