net.shibboleth.utilities.java.support.service

Class AbstractReloadableService<T>

java.lang.Object

net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

net.shibboleth.utilities.java.support.service.AbstractReloadableService<T>

Type Parameters:

T - The sort of service this implements.

All Implemented Interfaces:

Component, DestructableComponent, IdentifiableComponent, IdentifiedComponent, InitializableComponent, UnmodifiableComponent, ReloadableService<T>

public abstract class AbstractReloadableService<T>
extends AbstractIdentifiableInitializableComponent
implements ReloadableService<T>, UnmodifiableComponent

Base class for ReloadableService. This base class will use a background thread that will perform a periodic check, via shouldReload(), and, if required, invoke the services reload() method.
This class does not deal with any synchronization. That is left to implementing classes.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AbstractReloadableService.ServiceReloadTask A watcher that determines if a service should be reloaded and does so as appropriate.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	failFast Do we fail immediately if the config is bogus?
private java.util.Timer	internalTaskTimer Timer used to schedule reload tasks if no external one set.
private org.joda.time.DateTime	lastReloadInstant The last time time the service was reloaded, whether successful or not.
private org.joda.time.DateTime	lastSuccessfulReleaseInstant The last time the service was reloaded successfully.
private org.slf4j.Logger	log Class logger.
private java.lang.String	logPrefix The log prefix.
private long	reloadCheckDelay Number of milliseconds between one reload check and another.
private java.lang.Throwable	reloadFailureCause The cause of the last reload failure, if the last reload failed.
private AbstractReloadableService.ServiceReloadTask	reloadTask Watcher that monitors the set of configuration resources for this service for changes.
private java.util.Timer	reloadTaskTimer Timer used to schedule configuration reload tasks.

Constructor Summary

Constructors

Constructor and Description
AbstractReloadableService() Constructor.

Method Summary

Modifier and Type	Method and Description
protected void	doDestroy() Performs component specific destruction logic.
protected void	doInitialize() This method checks to ensure that the component ID is not null.
protected void	doReload() Performs the actual reload.
org.joda.time.DateTime	getLastReloadAttemptInstant() Gets the time when the service last attempted to reload.
org.joda.time.DateTime	getLastSuccessfulReloadInstant() Gets the time when the service was last successfully reloaded.
protected java.lang.String	getLogPrefix() Return a string which is to be prepended to all log messages.
long	getReloadCheckDelay() Gets the number of milliseconds between one reload check and another.
java.lang.Throwable	getReloadFailureCause() Gets the reason the last reload failed.
java.util.Timer	getReloadTaskTimer() Gets the timer used to schedule configuration reload tasks.
boolean	isFailFast() Do we fail fast?
void	reload() Reloads the configuration of the service.
void	setFailFast(boolean value) Sets whether we fail fast.
void	setReloadCheckDelay(long delay) Sets the number of milliseconds between one reload check and another.
void	setReloadTaskTimer(java.util.Timer timer) Sets the timer used to schedule configuration reload tasks.
protected abstract boolean	shouldReload() Called by the AbstractReloadableService.ServiceReloadTask to determine if the service should be reloaded.

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiableInitializableComponent

setId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractIdentifiedInitializableComponent

getId

Methods inherited from class net.shibboleth.utilities.java.support.component.AbstractInitializableComponent

destroy, initialize, isDestroyed, isInitialized

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.shibboleth.utilities.java.support.service.ReloadableService

getServiceableComponent

Methods inherited from interface net.shibboleth.utilities.java.support.component.InitializableComponent

initialize, isInitialized

Methods inherited from interface net.shibboleth.utilities.java.support.component.IdentifiedComponent

getId

Field Detail

log

@Nonnull
private final org.slf4j.Logger log

Class logger.

reloadCheckDelay

@Duration
private long reloadCheckDelay

Number of milliseconds between one reload check and another.

reloadTaskTimer

@Nullable
private java.util.Timer reloadTaskTimer

Timer used to schedule configuration reload tasks.

internalTaskTimer

@Nullable
private java.util.Timer internalTaskTimer

Timer used to schedule reload tasks if no external one set.

reloadTask

@Nullable
private AbstractReloadableService.ServiceReloadTask reloadTask

Watcher that monitors the set of configuration resources for this service for changes.

lastReloadInstant

@Nullable
private org.joda.time.DateTime lastReloadInstant

The last time time the service was reloaded, whether successful or not.

lastSuccessfulReleaseInstant

@Nullable
private org.joda.time.DateTime lastSuccessfulReleaseInstant

The last time the service was reloaded successfully.

reloadFailureCause

@Nullable
private java.lang.Throwable reloadFailureCause

The cause of the last reload failure, if the last reload failed.

failFast

private boolean failFast

Do we fail immediately if the config is bogus?

logPrefix

@Nullable
private java.lang.String logPrefix

The log prefix.

Constructor Detail

AbstractReloadableService

public AbstractReloadableService()

Constructor.

Method Detail

getReloadCheckDelay

public long getReloadCheckDelay()

Gets the number of milliseconds between one reload check and another. A value of 0 or less indicates that no reloading will be performed.

Default value: 0

Returns:

number of milliseconds between one reload check and another

setReloadCheckDelay

public void setReloadCheckDelay(@Duration
                                long delay)

Sets the number of milliseconds between one reload check and another. A value of 0 or less indicates that no reloading will be performed. This setting can not be changed after the service has been initialized.

Parameters:

delay - number of milliseconds between one reload check and another

getReloadTaskTimer

@Nullable
public java.util.Timer getReloadTaskTimer()

Gets the timer used to schedule configuration reload tasks.

Returns:

timer used to schedule configuration reload tasks

setReloadTaskTimer

public void setReloadTaskTimer(@Nullable
                               java.util.Timer timer)

Sets the timer used to schedule configuration reload tasks. This setting can not be changed after the service has been initialized.

Parameters:

timer - timer used to schedule configuration reload tasks

getLastReloadAttemptInstant

@Nullable
public org.joda.time.DateTime getLastReloadAttemptInstant()

Gets the time when the service last attempted to reload. If the reload was successful this time should match the time given by ReloadableService.getLastSuccessfulReloadInstant().

Specified by:

getLastReloadAttemptInstant in interface ReloadableService<T>

Returns:

time when the service last attempted to reload

getLastSuccessfulReloadInstant

@Nullable
public org.joda.time.DateTime getLastSuccessfulReloadInstant()

Gets the time when the service was last successfully reloaded. Returns null if the service has never reloaded.

Specified by:

getLastSuccessfulReloadInstant in interface ReloadableService<T>

Returns:

time when the service was last successfully reloaded

getReloadFailureCause

@Nullable
public java.lang.Throwable getReloadFailureCause()

Gets the reason the last reload failed.

Specified by:

getReloadFailureCause in interface ReloadableService<T>

Returns:

reason the last reload failed or null if the last reload was successful

isFailFast

public boolean isFailFast()

Do we fail fast?

Returns:

Returns whether we fast.

setFailFast

public void setFailFast(boolean value)

Sets whether we fail fast.

Parameters:

value - what to set.

doInitialize

protected void doInitialize()
                     throws ComponentInitializationException

This method checks to ensure that the component ID is not null. Performs the initialization of the component. This method is executed within the lock on the object being initialized. The default implementation of this method is a no-op.

Overrides:

doInitialize in class AbstractIdentifiedInitializableComponent

Throws:

ComponentInitializationException - thrown if there is a problem initializing the component

doDestroy

protected void doDestroy()

Performs component specific destruction logic. This method is executed within the lock on the object being destroyed. The default implementation of this method is a no-op.

Overrides:

doDestroy in class AbstractInitializableComponent

reload

public final void reload()

Reloads the configuration of the service. Whether internal state is maintained between reloads is implementation dependent.

Specified by:

reload in interface ReloadableService<T>

shouldReload

protected abstract boolean shouldReload()

Called by the AbstractReloadableService.ServiceReloadTask to determine if the service should be reloaded.

No lock is held when this method is called, so any locking needed should be handled internally.

Returns:

true iff the service should be reloaded

doReload

protected void doReload()

Performs the actual reload.

No lock is held when this method is called, so any locking needed should be handled internally.

Throws:

ServiceException - thrown if there is a problem reloading the service

getLogPrefix

@Nonnull
 @NotEmpty
protected java.lang.String getLogPrefix()

Return a string which is to be prepended to all log messages.

Returns:

"Service '' :"