edu.internet2.middleware.shibboleth.common.config

クラス BaseReloadableService

java.lang.Object

edu.internet2.middleware.shibboleth.common.config.BaseService

edu.internet2.middleware.shibboleth.common.config.BaseReloadableService

すべての実装されたインタフェース:

ReloadableService, Service, org.springframework.beans.factory.BeanNameAware, org.springframework.context.ApplicationContextAware

直系の既知のサブクラス:

IdPProfileHandlerManager, SAMLMDRelyingPartyConfigurationManager, ShibbolethAttributeFilteringEngine, ShibbolethAttributeResolver

public abstract class BaseReloadableService
extends BaseService
implements ReloadableService

An extension to BaseService that allows the service's context to be reloaded if the underlying configuration resources are changed. If, at construction time, polling frequency and retry attempt are given then the configuration resources will be watched for changes. If a change is detected then the current service's context will be dropped and a new one created from all resource files. If there is a problem loading a configuration resource during this process the existing service context is kept and an error is logged. The result of this occuring during the initial configuration load is implementation dependent. NOTE: Service implementations must take out a read lock, through BaseService.getReadWriteLock(), whenever reading or operating on information controlled by the service context. This will ensure that if a configuration change occurs the service context will not be replaced until after all current reads have completed.

ネストされたクラスの概要

ネストされたクラス

修飾子とタイプ	クラスと説明
protected class	BaseReloadableService.ConfigurationResourceListener A listener for policy resource changes that triggers a reloading of the AFP context.

コンストラクタの概要

コンストラクタ

コンストラクタと説明
BaseReloadableService() Constructor.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
void	destroy() Destroys a service, freeing any resources it may currently be using.
long	getPollingFrequency() Gets the frequency, in milliseconds, that the configuration resources are polled.
int	getPollingRetryAttempts() Gets the number of times a resource may error out before it is considered permanently invalid.
Timer	getPollingTimer() Gets the timer used to resource polling jobs.
void	initialize() Initializes this service.
void	reload() Reloads the configuration of the service.
void	setPollingFrequency(long frequency) Sets the frequency, in milliseconds, that the configuration resources are polled.
void	setPollingRetryAttempts(int attempts) Sets the number of times a resource may error out before it is considered permanently invalid.
void	setPollingTimer(Timer timer) Sets the timer used to resource polling jobs.

クラスから継承されたメソッド edu.internet2.middleware.shibboleth.common.config.BaseService

getApplicationContext, getId, getReadWriteLock, getServiceConfigurations, getServiceContext, isDestroyed, isInitialized, loadContext, onNewContextCreated, setApplicationContext, setBeanName, setInitialized, setServiceConfigurations, setServiceContext

クラスから継承されたメソッド java.lang.Object

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

インタフェースから継承されたメソッド edu.internet2.middleware.shibboleth.common.service.Service

getId, isDestroyed, isInitialized

コンストラクタの詳細

BaseReloadableService

public BaseReloadableService()

Constructor. Configuration resources are not monitored for changes. Sets polling frequency to 0 and retry attempts to 0.

メソッドの詳細

getPollingTimer

public Timer getPollingTimer()

Gets the timer used to resource polling jobs.

戻り値:

timer used to resource polling jobs

setPollingTimer

public void setPollingTimer(Timer timer)

Sets the timer used to resource polling jobs.

パラメータ:

timer - timer used to resource polling jobs

getPollingFrequency

public long getPollingFrequency()

Gets the frequency, in milliseconds, that the configuration resources are polled.

戻り値:

frequency, in milliseconds, that the configuration resources are polled

setPollingFrequency

public void setPollingFrequency(long frequency)

Sets the frequency, in milliseconds, that the configuration resources are polled.

パラメータ:

frequency - the frequency, in milliseconds, that the configuration resources are polled

getPollingRetryAttempts

public int getPollingRetryAttempts()

Gets the number of times a resource may error out before it is considered permanently invalid.

戻り値:

number of times a resource may error out before it is considered permanently invalid

setPollingRetryAttempts

public void setPollingRetryAttempts(int attempts)

Sets the number of times a resource may error out before it is considered permanently invalid.

パラメータ:

attempts - number of times a resource may error out before it is considered permanently invalid

initialize

public void initialize()
                throws ServiceException

Initializes this service. Calling this on an initialized service should return immediately without affecting any service state.

定義:

initialize インタフェース内 Service

オーバーライド:

initialize クラス内 BaseService

例外:

ServiceException - thrown if there is a problem initializing the service

reload

public void reload()
            throws ServiceException

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

定義:

reload インタフェース内 ReloadableService

例外:

ServiceException - thrown if there is a problem reloading the service

destroy

public void destroy()
             throws ServiceException

Destroys a service, freeing any resources it may currently be using. Whether a service can be re-initialized after being destroyed is implementation dependent.

定義:

destroy インタフェース内 Service

オーバーライド:

destroy クラス内 BaseService

例外:

ServiceException - thrown if there is a problem destroying the service