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 group low level hooks


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_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_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)
           
 
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 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 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_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_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(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 -
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 -
attributeLoaderAttrQuery1 -
attributeLoaderAttrSetQuery1 -
attributeLoaderAttrsLike1 -
attributeLoaderActionQuery1 -
attributeLoaderActionSetQuery1 -
Method Detail

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 -