org.onehippo.repository.modules

Class AbstractReconfigurableSchedulingDaemonModule

java.lang.Object

org.onehippo.repository.modules.AbstractReconfigurableDaemonModule

org.onehippo.repository.modules.AbstractReconfigurableSchedulingDaemonModule

All Implemented Interfaces:

ConfigurableDaemonModule, DaemonModule

Deprecated.

deprecated since 2.28.00, register a repository job with the repository scheduler directly using configuration

@Deprecated
public abstract class AbstractReconfigurableSchedulingDaemonModule
extends AbstractReconfigurableDaemonModule

Abstract base class extending AbstractReconfigurableDaemonModule to allow easy (un)registering of a scheduled job with some default optimization when dealing with JCR events.

Derived classes are responsible for creating/returning a valid job info and job trigger by implementing getRepositoryJobInfo(Node) and getRepositoryJobTrigger(Node, RepositoryJobInfo). Also, they can return false in isSchedulerEnabled(Node) when the scheduled job should be disabled.

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CONFIG_LOCK_ISDEEP_PROPERTY Deprecated.
protected static String	CONFIG_LOCK_OWNER Deprecated.
protected static String	DEFAULT_GROUP Deprecated.

Fields inherited from class org.onehippo.repository.modules.AbstractReconfigurableDaemonModule

moduleConfigPath, moduleName, session

Constructor Summary

Constructors

Constructor and Description
AbstractReconfigurableSchedulingDaemonModule() Deprecated.

Method Summary

Modifier and Type	Method and Description
protected void	doConfigure(javax.jcr.Node moduleConfig) Deprecated. Lifecycle callback to allow a DaemonModule to configure itself.
protected void	doInitialize(javax.jcr.Session session) Deprecated. Lifecycle callback that is called when this module is started.
protected void	doShutdown() Deprecated. Lifecycle callback method that is called by the repository before shutting down .
protected abstract RepositoryJobInfo	getRepositoryJobInfo(javax.jcr.Node moduleConfig) Deprecated. Returns the scheduled task job info.
protected abstract RepositoryJobTrigger	getRepositoryJobTrigger(javax.jcr.Node moduleConfig, RepositoryJobInfo jobInfo) Deprecated. Returns the scheduled task job trigger.
protected boolean	isReconfigureEvent(javax.jcr.observation.Event event) Deprecated. Called by the module configuration listener on event.
protected boolean	isSchedulerEnabled(javax.jcr.Node moduleConfig) Deprecated. Returns true only when the scheduling daemon is enabled.
protected void	onConfigurationChange(javax.jcr.Node moduleConfig) Deprecated. Called when the module configuration has changed.
protected void	scheduleJob(javax.jcr.Node moduleConfig) Deprecated.
protected void	unscheduleJob() Deprecated.

Methods inherited from class org.onehippo.repository.modules.AbstractReconfigurableDaemonModule

configure, initialize, shutdown

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CONFIG_LOCK_ISDEEP_PROPERTY

protected static final String CONFIG_LOCK_ISDEEP_PROPERTY

Deprecated.

See Also:

Constant Field Values

CONFIG_LOCK_OWNER

protected static final String CONFIG_LOCK_OWNER

Deprecated.

See Also:

Constant Field Values

DEFAULT_GROUP

protected static final String DEFAULT_GROUP

Deprecated.

See Also:

Constant Field Values

Constructor Detail

AbstractReconfigurableSchedulingDaemonModule

public AbstractReconfigurableSchedulingDaemonModule()

Deprecated.

Method Detail

doConfigure

protected void doConfigure(javax.jcr.Node moduleConfig)
                    throws javax.jcr.RepositoryException

Deprecated.

Description copied from class: AbstractReconfigurableDaemonModule

Lifecycle callback to allow a DaemonModule to configure itself. This method is called on startup iff there is module config node, and before AbstractReconfigurableDaemonModule.initialize(javax.jcr.Session) is called. This method is also called when the module config node or any of its descendants changes.

Specified by:

doConfigure in class AbstractReconfigurableDaemonModule

Parameters:

moduleConfig - the node containing the configuration of this module

Throws:

javax.jcr.RepositoryException

doInitialize

protected void doInitialize(javax.jcr.Session session)
                     throws javax.jcr.RepositoryException

Deprecated.

Description copied from class: AbstractReconfigurableDaemonModule

Lifecycle callback that is called when this module is started.

Specified by:

doInitialize in class AbstractReconfigurableDaemonModule

Parameters:

session - a Session that can be used throughout this module's life.

Throws:

javax.jcr.RepositoryException

doShutdown

protected void doShutdown()

Deprecated.

Description copied from class: AbstractReconfigurableDaemonModule

Lifecycle callback method that is called by the repository before shutting down .

Specified by:

doShutdown in class AbstractReconfigurableDaemonModule

isReconfigureEvent

protected boolean isReconfigureEvent(javax.jcr.observation.Event event)
                              throws javax.jcr.RepositoryException

Deprecated.

Description copied from class: AbstractReconfigurableDaemonModule

Called by the module configuration listener on event. As an optimization, may be overridden to return false for events that are actually not a configuration change, so that they don't trigger a reconfiguration.

Overrides:

isReconfigureEvent in class AbstractReconfigurableDaemonModule

Parameters:

event - event returned by the EventIterator

Returns:

true if this event requires reloading of the configuration

Throws:

javax.jcr.RepositoryException

onConfigurationChange

protected void onConfigurationChange(javax.jcr.Node moduleConfig)
                              throws javax.jcr.RepositoryException

Deprecated.

Description copied from class: AbstractReconfigurableDaemonModule

Called when the module configuration has changed. The default implementation just calls AbstractReconfigurableDaemonModule.doConfigure(javax.jcr.Node) but this method may be overridden.

Overrides:

onConfigurationChange in class AbstractReconfigurableDaemonModule

Parameters:

moduleConfig - the new module configuration node

Throws:

javax.jcr.RepositoryException

unscheduleJob

protected void unscheduleJob()

Deprecated.

scheduleJob

protected void scheduleJob(javax.jcr.Node moduleConfig)

Deprecated.

isSchedulerEnabled

protected boolean isSchedulerEnabled(javax.jcr.Node moduleConfig)
                              throws javax.jcr.RepositoryException

Deprecated.

Returns true only when the scheduling daemon is enabled. By default, it is enabled.

Parameters:

moduleConfig -

Throws:

javax.jcr.RepositoryException

getRepositoryJobInfo

protected abstract RepositoryJobInfo getRepositoryJobInfo(javax.jcr.Node moduleConfig)
                                                   throws javax.jcr.RepositoryException

Deprecated.

Returns the scheduled task job info.

Parameters:

moduleConfig -

Throws:

javax.jcr.RepositoryException

getRepositoryJobTrigger

protected abstract RepositoryJobTrigger getRepositoryJobTrigger(javax.jcr.Node moduleConfig,
                                                                RepositoryJobInfo jobInfo)
                                                         throws javax.jcr.RepositoryException

Deprecated.

Returns the scheduled task job trigger.

Parameters:

moduleConfig -

jobInfo -

Throws:

javax.jcr.RepositoryException