EhCacheManagerFactoryBean (Spring Framework 5.0.0.RELEASE API)

java.lang.ObjectSE
- org.springframework.cache.ehcache.EhCacheManagerFactoryBean

実装されているすべてのインターフェース:
DisposableBean, FactoryBean<CacheManager>, InitializingBean
```
public class EhCacheManagerFactoryBean
extends ObjectSE
implements FactoryBean<CacheManager>, InitializingBean, DisposableBean
```
指定された構成場所から構成された EhCache CacheManager インスタンス（独立または共有）を公開する FactoryBean。
構成場所が指定されていない場合、CacheManager はクラスパスのルートにある "ehcache.xml" から構成されます（つまり、デフォルトの EhCache 初期化（EhCache ドキュメントで定義されている）が適用されます）。
（デフォルトで）独立した CacheManager インスタンスを提供し、CacheManager の適切なシャットダウンを考慮しているため、EhCacheFactoryBean を使用する場合は、別の EhCacheManagerFactoryBean をセットアップすることもお勧めします。EhCacheManagerFactoryBean は、デフォルト以外の設定場所から EhCache 設定をロードするためにも必要です。
メモ: Spring 5.0 以降、Spring の EhCache サポートには EhCache 2.10 以上が必要です。
導入:
1.1.1
作成者:
Juergen Hoeller, Dmitriy Kopylenko
関連事項:
setConfigLocation(org.springframework.core.io.Resource), setShared(boolean), EhCacheFactoryBean, CacheManager

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
protected Log logger

フィールド
修飾子と型	フィールドと説明
`protected Log`	`logger`

コンストラクターの概要
コンストラクター
コンストラクターと説明
EhCacheManagerFactoryBean()

コンストラクター
コンストラクターと説明
`EhCacheManagerFactoryBean()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()` 指定されたすべての Bean プロパティを設定した（そして BeanFactoryAware と ApplicationContextAware を満たした）後に BeanFactory によって呼び出されます。
`void`	`destroy()` シングルトンの破棄時に BeanFactory によって呼び出されます。
`CacheManager`	`getObject()` このファクトリによって管理されるオブジェクトのインスタンス（おそらく共有または独立）を返します。
`ClassSE<? extends CacheManager>`	`getObjectType()` この FactoryBean が作成するオブジェクトの型を返します。事前にわからない場合は `null` を返します。
`boolean`	`isSingleton()` このファクトリによって管理されるオブジェクトはシングルトンですか？つまり、`FactoryBean.getObject()` は常に同じオブジェクト（キャッシュ可能な参照）を返しますか？
`void`	`setAcceptExisting(boolean acceptExisting)` この EhCacheManagerFactoryBean セットアップで同じ名前の既存の EhCache CacheManager を受け入れるかどうかを設定します。
`void`	`setCacheManagerName(StringSE cacheManagerName)` EhCache CacheManager の名前を設定します（特定の名前が必要な場合）。
`void`	`setConfigLocation(Resource configLocation)` EhCache 構成ファイルの場所を設定します。
`void`	`setShared(boolean shared)` EhCache CacheManager を共有する（ClassLoader レベルのシングルトンとして）か、独立する（通常はアプリケーション内でローカル）かを設定します。

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- フィールドの詳細
  - logger
```
protected final Log logger
```
- コンストラクターの詳細
  - EhCacheManagerFactoryBean
```
public EhCacheManagerFactoryBean()
```
- メソッドの詳細
  - setConfigLocation
```
public void setConfigLocation(Resource configLocation)
```
    EhCache 構成ファイルの場所を設定します。一般的な値は "/WEB-INF/ehcache.xml" です。
    デフォルトは、クラスパスのルートにある "ehcache.xml" です。見つからない場合は、EhCache jar にある "ehcache-failsafe.xml" （デフォルトは EhCache 初期化）です。
    関連事項:
    CacheManager.create(java.io.InputStream), CacheManager.CacheManager(java.io.InputStream)
  - setCacheManagerName
```
public void setCacheManagerName(StringSE cacheManagerName)
```
    EhCache CacheManager の名前を設定します（特定の名前が必要な場合）。
    関連事項:
    Configuration.setName(String)
  - setAcceptExisting
```
public void setAcceptExisting(boolean acceptExisting)
```
    この EhCacheManagerFactoryBean セットアップで同じ名前の既存の EhCache CacheManager を受け入れるかどうかを設定します。デフォルトは "false" です。
    通常は "cacheManagerName" と組み合わせて使用されますが、何も指定されていない場合は、デフォルトの CacheManager 名で機能します。同じ ClassLoader スペース内の同じ CacheManager 名（または同じデフォルト）へのすべての参照は、指定された CacheManager を共有します。
    関連事項:
    #see #setShared, CacheManager.getCacheManager(String), CacheManager.CacheManager()
  - setShared
```
public void setShared(boolean shared)
```
    EhCache CacheManager を共有する（ClassLoader レベルのシングルトンとして）か、独立する（通常はアプリケーション内でローカル）かを設定します。デフォルトは "false" で、独立したローカルインスタンスを作成します。
    注意 : この機能により、この EhCacheManagerFactoryBean の CacheManager を、同じ ClassLoader スペースで CacheManager.create() を呼び出す任意のコードと共有できます。特定の CacheManager 名について合意する必要はありません。ただし、基礎となる CacheManager のライフサイクル（特に、そのシャットダウン）を制御する、関与する単一の EhCacheManagerFactoryBean のみをサポートします。
    このフラグは "acceptExisting" をオーバーライドします。両方が設定されている場合、「より強力な」共有モードを示しているためです。
    関連事項:
    setCacheManagerName(java.lang.String), setAcceptExisting(boolean), CacheManager.create(), CacheManager.CacheManager()
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws CacheException
```
    インターフェースからコピーされた説明: InitializingBean
    指定されたすべての Bean プロパティを設定した（そして BeanFactoryAware と ApplicationContextAware を満たした）後に BeanFactory によって呼び出されます。
    このメソッドにより、Bean インスタンスは、すべての Bean プロパティが設定されている場合にのみ可能な初期化を実行し、設定ミスの場合に例外をスローできます。
    次で指定:
    インターフェース InitializingBean の afterPropertiesSet
    例外:
    CacheException
  - getObject
```
@Nullable
public CacheManager getObject()
```
    インターフェースからコピーされた説明: FactoryBean
    このファクトリによって管理されるオブジェクトのインスタンス（おそらく共有または独立）を返します。
    BeanFactory と同様に、これにより、シングルトンとプロトタイプの両方のデザインパターンをサポートできます。
    この FactoryBean が呼び出し時にまだ完全に初期化されていない場合（たとえば、循環参照に関係しているため）、対応する FactoryBeanNotInitializedException をスローします。
    Spring 2.0 以降、FactoryBeans は null オブジェクトを返すことができます。ファクトリはこれを通常の値として使用します。この場合、FactoryBeanNotInitializedException はスローされません。FactoryBean の実装では、必要に応じて FactoryBeanNotInitializedException 自体をすぐにスローすることをお勧めします。
    次で指定:
    インターフェース FactoryBean<CacheManager> の getObject
    戻り値:
    Bean のインスタンス (null にすることができます)
    関連事項:
    FactoryBeanNotInitializedException
  - getObjectType
```
public ClassSE<? extends CacheManager> getObjectType()
```
    インターフェースからコピーされた説明: FactoryBean
    この FactoryBean が作成するオブジェクトの型を返します。事前にわからない場合は null を返します。
    これにより、たとえばオートワイヤーなどで、オブジェクトをインスタンス化せずに特定の型の Bean を確認できます。
    シングルトンオブジェクトを作成している実装の場合、このメソッドはシングルトンの作成を可能な限り回避しようとします。むしろ、事前に型を推定する必要があります。プロトタイプの場合、ここで意味のある型を返すこともお勧めします。
    このメソッドは、この FactoryBean が完全に初期化される前に呼び出すことができます。初期化中に作成された状態に依存しないでください。もちろん、利用可能な場合はそのような状態を引き続き使用できます。
    注意 : オートワイヤーは、ここで null を返す FactoryBeans を単に無視します。FactoryBean の現在の状態を使用して、このメソッドを適切に実装することを強くお勧めします。
    次で指定:
    インターフェース FactoryBean<CacheManager> の getObjectType
    戻り値:
    この FactoryBean が作成するオブジェクトの型、または呼び出し時に不明な場合は null
    関連事項:
    ListableBeanFactory.getBeansOfType(java.lang.Class<T>)
  - isSingleton
```
public boolean isSingleton()
```
    インターフェースからコピーされた説明: FactoryBean
    このファクトリによって管理されるオブジェクトはシングルトンですか？つまり、FactoryBean.getObject() は常に同じオブジェクト（キャッシュ可能な参照）を返しますか？
    注意 : FactoryBean がシングルトンオブジェクトを保持することを示す場合、getObject() から返されたオブジェクトは所有 BeanFactory によってキャッシュされる可能性があります。FactoryBean が常に同じ参照を公開しない限り、true を返さないでください。
    FactoryBean 自体のシングルトンステータスは、通常、所有する BeanFactory によって提供されます。通常、そこではシングルトンとして定義する必要があります。
    注意 : false を返すこのメソッドは、返されるオブジェクトが独立したインスタンスであることを必ずしも示しません。拡張 SmartFactoryBean インターフェースの実装は、SmartFactoryBean.isPrototype() メソッドを通じて独立したインスタンスを明示的に示す場合があります。この拡張インターフェースを実装しないプレーンな FactoryBean 実装は、isSingleton() 実装が false を返す場合、常に独立したインスタンスを返すと単純に想定されます。
    FactoryBean は通常シングルトンインスタンスを管理するため、デフォルトの実装では true が返されます。
    次で指定:
    インターフェース FactoryBean<CacheManager> の isSingleton
    戻り値:
    公開されたオブジェクトがシングルトンかどうか
    関連事項:
    FactoryBean.getObject(), SmartFactoryBean.isPrototype()
  - destroy
```
public void destroy()
```
    インターフェースからコピーされた説明: DisposableBean
    シングルトンの破棄時に BeanFactory によって呼び出されます。
    次で指定:
    インターフェース DisposableBean の destroy

クラス EhCacheManagerFactoryBean

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

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

フィールドの詳細

logger

コンストラクターの詳細

EhCacheManagerFactoryBean

メソッドの詳細

setConfigLocation

setCacheManagerName

setAcceptExisting

setShared

afterPropertiesSet

getObject

getObjectType

isSingleton

destroy