BaseService (Shibboleth Identity Provider 2.3.0 API)

java.lang.Object
- edu.internet2.middleware.shibboleth.common.config.BaseService

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

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

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

BaseReloadableService, ShibbolethSAML1AttributeAuthority, ShibbolethSAML2AttributeAuthority
```
public abstract class BaseService
extends Object
implements Service, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.BeanNameAware
```
A service whose Spring beans are loaded into a service specific ApplicationContext that is a child of the context provided in setApplicationContext(ApplicationContext). Services derived from this base class may not be re-initialized after they have been destroyed.

コンストラクタの概要

コンストラクタ
コンストラクタと説明

BaseService()
Constructor.

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

メソッドの概要

メソッド
修飾子とタイプ	メソッドと説明
`void`	`destroy()` Destroys a service, freeing any resources it may currently be using.
`org.springframework.context.ApplicationContext`	`getApplicationContext()` Gets the application context that is the parent to this service's context.
`String`	`getId()` Gets the ID of this service.
`protected ReadWriteLock`	`getReadWriteLock()` Gets the read-write lock guarding the service context.
`List<Resource>`	`getServiceConfigurations()` Gets an unmodifiable list of configurations for this service.
`org.springframework.context.ApplicationContext`	`getServiceContext()` Gets this service's context.
`void`	`initialize()` Initializes this service.
`boolean`	`isDestroyed()` Gets whether the service has been destroyed.
`boolean`	`isInitialized()` Gets whether the service is initialized and ready for use.
`protected void`	`loadContext()` Loads the service context.
`protected abstract void`	`onNewContextCreated(org.springframework.context.ApplicationContext newServiceContext)` Called after a new context has been created but before it set as the service's context.
`void`	`setApplicationContext(org.springframework.context.ApplicationContext applicationContext)` Sets the application context that is the parent to this service's context.
`void`	`setBeanName(String name)`
`protected void`	`setInitialized(boolean initialized)` Sets whether this service has been initialized.
`void`	`setServiceConfigurations(List<Resource> configurations)` Sets the service's configuration resources.
`protected void`	`setServiceContext(org.springframework.context.support.GenericApplicationContext context)` Sets this service's context.

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - BaseService
```
public BaseService()
```
    Constructor.
- メソッドの詳細
  - 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
    
    例外:
    
    ServiceException - thrown if there is a problem destroying the service
  - getApplicationContext
```
public org.springframework.context.ApplicationContext getApplicationContext()
```
    Gets the application context that is the parent to this service's context.
    
    戻り値:
    application context that is the parent to this service's context
  - getId
```
public String getId()
```
    Gets the ID of this service.
    
    定義:
    
    getId インタフェース内 Service
    
    戻り値:
    ID of this service
  - getReadWriteLock
```
protected ReadWriteLock getReadWriteLock()
```
    Gets the read-write lock guarding the service context.
    
    戻り値:
    read-write lock guarding the service context
  - getServiceConfigurations
```
public List<Resource> getServiceConfigurations()
```
    Gets an unmodifiable list of configurations for this service.
    
    戻り値:
    unmodifiable list of configurations for this service
  - getServiceContext
```
public org.springframework.context.ApplicationContext getServiceContext()
```
    Gets this service's context.
    
    戻り値:
    this service's context
  - 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
    
    例外:
    
    ServiceException - thrown if there is a problem initializing the service
  - isInitialized
```
public boolean isInitialized()
```
    Gets whether the service is initialized and ready for use.
    
    定義:
    
    isInitialized インタフェース内 Service
    
    戻り値:
    true if the service is ready for use, false it not
  - isDestroyed
```
public boolean isDestroyed()
```
    Gets whether the service has been destroyed.
    
    定義:
    
    isDestroyed インタフェース内 Service
    
    戻り値:
    true if the service has been destroyed
  - loadContext
```
protected void loadContext()
                    throws ServiceException
```
    Loads the service context.
    
    例外:
    
    ServiceException - thrown if the configuration for this service could not be loaded
  - onNewContextCreated
```
protected abstract void onNewContextCreated(org.springframework.context.ApplicationContext newServiceContext)
                                     throws ServiceException
```
    Called after a new context has been created but before it set as the service's context. If an exception is thrown the new context will not be set as the service's context and the current service context will be retained.
    
    パラメータ:
    newServiceContext - the newly created context for the service
    
    例外:
    
    ServiceException - thrown if there is a problem with the given service context
  - setApplicationContext
```
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
```
    Sets the application context that is the parent to this service's context.
    
    定義:
    
    setApplicationContext インタフェース内 org.springframework.context.ApplicationContextAware
  - setBeanName
```
public void setBeanName(String name)
```
    定義:
    
    setBeanName インタフェース内 org.springframework.beans.factory.BeanNameAware
  - setInitialized
```
protected void setInitialized(boolean initialized)
```
    Sets whether this service has been initialized.
    
    パラメータ:
    initialized - whether this service has been initialized
  - setServiceConfigurations
```
public void setServiceConfigurations(List<Resource> configurations)
```
    Sets the service's configuration resources.
    
    パラメータ:
    configurations - configuration resources for the service
  - setServiceContext
```
protected void setServiceContext(org.springframework.context.support.GenericApplicationContext context)
```
    Sets this service's context.
    
    パラメータ:
    context - this service's context

クラス BaseService

コンストラクタの概要

メソッドの概要

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

コンストラクタの詳細

BaseService

メソッドの詳細

destroy

getApplicationContext

getId

getReadWriteLock

getServiceConfigurations

getServiceContext

initialize

isInitialized

isDestroyed

loadContext

onNewContextCreated

setApplicationContext

setBeanName

setInitialized

setServiceConfigurations

setServiceContext