edu.internet2.middleware.grouperClientExt.xmpp
Class GrouperClientXmppJob

java.lang.Object
  extended by edu.internet2.middleware.grouperClientExt.xmpp.GrouperClientXmppJob

public class GrouperClientXmppJob
extends Object

bean that holds config data for grouper client xmpp job


Nested Class Summary
static class GrouperClientXmppJob.XmppJobEventAction
          enum for action when event happens
 
Constructor Summary
GrouperClientXmppJob()
           
 
Method Summary
 String getElfilter()
          elfilter that decides if the event is worth processsing
 GrouperClientXmppJob.XmppJobEventAction getEventAction()
          event action on each event
 String getFilePrefix()
          prefix to put at the beginning of file (before users)
 String getFileSuffix()
          suffix to put at the end of file (after users)
 String getFullRefreshQuartzCronString()
          how often a full refresh should occur regardless of events, quartz cron like string, e.g.
 Set<String> getGroupNames()
          group names which trigger notifications
 String getHandlerClass()
          class that handles events on this job
 String getIteratorEl()
          expression language for each user, e.g.
 String getJobName()
          name of job
 List<String> getSubjectAttributeNames()
          subject attribute names for full refresh
 String getTargetFile()
          file to write for file handler jobs
static GrouperClientXmppJob retrieveJob(String name, boolean exceptionIfNotFound)
          retrieve a job by name
static List<GrouperClientXmppJob> retrieveXmppJobs()
          retrieve the cached xmpp jobs
 void setElfilter(String elfilter1)
          elfilter that decides if the event is worth processsing
 void setEventAction(GrouperClientXmppJob.XmppJobEventAction eventAction1)
          event action on each event
 void setFilePrefix(String filePrefix1)
          prefix to put at the beginning of file (before users)
 void setFileSuffix(String fileSuffix1)
          suffix to put at the end of file (after users)
 void setFullRefreshQuartzCronString(String fullRefreshQuartzCronString1)
          how often a full refresh should occur regardless of events, quartz cron like string, e.g.
 void setGroupNames(Set<String> groupNames)
          group names which trigger notifications
 void setHandlerClass(String handlerClass1)
          class that handles events on this job
 void setIteratorEl(String iteratorEl1)
          expression language for each user, e.g.
 void setJobName(String jobName1)
          name of job
 void setSubjectAttributeNames(List<String> subjectAttributeNames1)
          subject attribute names for full refresh
 void setTargetFile(String targetFile1)
          file to write for file handler jobs
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GrouperClientXmppJob

public GrouperClientXmppJob()
Method Detail

getJobName

public String getJobName()
name of job

Returns:
the jobName

setJobName

public void setJobName(String jobName1)
name of job

Parameters:
jobName1 - the jobName to set

getEventAction

public GrouperClientXmppJob.XmppJobEventAction getEventAction()
event action on each event

Returns:
the eventAction

setEventAction

public void setEventAction(GrouperClientXmppJob.XmppJobEventAction eventAction1)
event action on each event

Parameters:
eventAction1 - the eventAction to set

retrieveJob

public static GrouperClientXmppJob retrieveJob(String name,
                                               boolean exceptionIfNotFound)
retrieve a job by name

Parameters:
name -
exceptionIfNotFound -
Returns:
the job

retrieveXmppJobs

public static List<GrouperClientXmppJob> retrieveXmppJobs()
retrieve the cached xmpp jobs

Returns:
jobs

getSubjectAttributeNames

public List<String> getSubjectAttributeNames()
subject attribute names for full refresh

Returns:
the subjectAttributeNames

setSubjectAttributeNames

public void setSubjectAttributeNames(List<String> subjectAttributeNames1)
subject attribute names for full refresh

Parameters:
subjectAttributeNames1 - the subjectAttributeNames to set

getGroupNames

public Set<String> getGroupNames()
group names which trigger notifications

Returns:
group names which trigger notifications

setGroupNames

public void setGroupNames(Set<String> groupNames)
group names which trigger notifications

Parameters:
groupNames -

getElfilter

public String getElfilter()
elfilter that decides if the event is worth processsing

Returns:
elfilter

setElfilter

public void setElfilter(String elfilter1)
elfilter that decides if the event is worth processsing

Parameters:
elfilter1 -

getHandlerClass

public String getHandlerClass()
class that handles events on this job

Returns:
the handlerClass

setHandlerClass

public void setHandlerClass(String handlerClass1)
class that handles events on this job

Parameters:
handlerClass1 - the handlerClass to set

getFullRefreshQuartzCronString

public String getFullRefreshQuartzCronString()
how often a full refresh should occur regardless of events, quartz cron like string, e.g. on the 8am each day: 0 0 8 * * ?

Returns:
the fullRefreshQuartzCronString

setFullRefreshQuartzCronString

public void setFullRefreshQuartzCronString(String fullRefreshQuartzCronString1)
how often a full refresh should occur regardless of events, quartz cron like string, e.g. on the 8am each day: 0 0 8 * * ?

Parameters:
fullRefreshQuartzCronString1 - the fullRefreshQuartzCronString to set

getTargetFile

public String getTargetFile()
file to write for file handler jobs

Returns:
the targetFile

setTargetFile

public void setTargetFile(String targetFile1)
file to write for file handler jobs

Parameters:
targetFile1 - the targetFile to set

getFilePrefix

public String getFilePrefix()
prefix to put at the beginning of file (before users)

Returns:
the filePrefix

setFilePrefix

public void setFilePrefix(String filePrefix1)
prefix to put at the beginning of file (before users)

Parameters:
filePrefix1 - the filePrefix to set

getIteratorEl

public String getIteratorEl()
expression language for each user, e.g. ${subject['pennname']}$space$ note: $newline$ is also ok for new lines.

Returns:
the iteratorEl

setIteratorEl

public void setIteratorEl(String iteratorEl1)
expression language for each user, e.g. ${subject['pennname']}$space$ note: $newline$ is also ok for new lines.

Parameters:
iteratorEl1 - the iteratorEl to set

getFileSuffix

public String getFileSuffix()
suffix to put at the end of file (after users)

Returns:
the fileSuffix

setFileSuffix

public void setFileSuffix(String fileSuffix1)
suffix to put at the end of file (after users)

Parameters:
fileSuffix1 - the fileSuffix to set


Copyright © 2010 Internet2. All Rights Reserved.