|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.crowd.manager.directory.monitor.poller.AbstractQuartzDirectoryPollerManager
public abstract class AbstractQuartzDirectoryPollerManager
Field Summary | |
---|---|
static String |
DIRECTORY_POLLER_JOB_GROUP
|
Constructor Summary | |
---|---|
AbstractQuartzDirectoryPollerManager()
|
Method Summary | |
---|---|
void |
addPoller(DirectoryPoller poller)
Adds a configured DirectoryPoller to the scheduler. |
protected abstract org.quartz.JobDetail |
buildJobDetail(DirectoryPoller poller)
|
protected abstract org.quartz.Trigger |
buildTrigger(DirectoryPoller poller,
org.quartz.JobDetail jobDetail)
|
protected String |
getJobName(long directoryID)
|
protected abstract org.quartz.Scheduler |
getScheduler()
|
boolean |
hasPoller(long directoryID)
Checks whether a DirectoryPoller is scheduled to poll a given directory. |
void |
removeAllPollers()
Attempts to unregister all registered pollers. |
boolean |
removePoller(long directoryID)
Removes the DirectoryPoller from the scheduler if one exists for the given directory. |
void |
triggerPoll(long directoryID,
SynchronisationMode synchronisationMode)
Manually triggers the directory poller to immediately poll the directory and synchronise changes. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String DIRECTORY_POLLER_JOB_GROUP
Constructor Detail |
---|
public AbstractQuartzDirectoryPollerManager()
Method Detail |
---|
public void addPoller(DirectoryPoller poller) throws DirectoryMonitorRegistrationException
DirectoryPollerManager
addPoller
in interface DirectoryPollerManager
poller
- configured DirectoryPoller.
DirectoryMonitorRegistrationException
- error registering poller with scheduler.protected abstract org.quartz.JobDetail buildJobDetail(DirectoryPoller poller) throws DirectoryMonitorRegistrationException
DirectoryMonitorRegistrationException
protected abstract org.quartz.Trigger buildTrigger(DirectoryPoller poller, org.quartz.JobDetail jobDetail) throws DirectoryMonitorRegistrationException
DirectoryMonitorRegistrationException
public boolean hasPoller(long directoryID)
DirectoryPollerManager
hasPoller
in interface DirectoryPollerManager
directoryID
- directory ID.
true
if and only if a poller has been scheduled.public void triggerPoll(long directoryID, SynchronisationMode synchronisationMode)
DirectoryPollerManager
DirectoryManager.isSynchronising(long)
.
If the directory does not exist or has no poller associated with it, this method
will do nothing. You can check if a directory has a poller associated with it by calling
DirectoryPollerManager.hasPoller(long)
.
triggerPoll
in interface DirectoryPollerManager
directoryID
- directory ID.synchronisationMode
- determines whether the poll only requests elements that have changed since a timestamp or if
it queries for the entire user base from the remote directory and determines changes locally.public boolean removePoller(long directoryID) throws DirectoryMonitorUnregistrationException
DirectoryPollerManager
removePoller
in interface DirectoryPollerManager
directoryID
- directory ID.
true
if and only if a poller existed
and was removed from polling the given directory.
DirectoryMonitorUnregistrationException
- If an error occurs during remove.public void removeAllPollers()
DirectoryPollerManager
removeAllPollers
in interface DirectoryPollerManager
protected String getJobName(long directoryID)
protected abstract org.quartz.Scheduler getScheduler()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |