EhCacheFactoryBean (Spring Framework API)

java.lang.ObjectSE
- net.sf.ehcache.config.CacheConfiguration
- - org.springframework.cache.ehcache.EhCacheFactoryBean

実装されたすべてのインターフェース:
CloneableSE, Aware, BeanNameAware, FactoryBean<Ehcache>, InitializingBean
```
public class EhCacheFactoryBean
extends CacheConfiguration
implements FactoryBean<Ehcache>, BeanNameAware, InitializingBean
```
EhCache CacheManager 内のキャッシュ領域を表す、名前付き EhCache Cache インスタンス（または Ehcache インターフェースを実装するデコレーター）を作成する FactoryBean。
指定された名前付きキャッシュがキャッシュ構成記述子で構成されていない場合、この FactoryBean は、指定された名前と指定されたキャッシュプロパティで Cache のインスタンスを構築し、後で取得するために CacheManager に追加します。構成時に一部またはすべてのプロパティが設定されていない場合、この FactoryBean はデフォルトを使用します。
メモ: 指定された Cache インスタンスが見つかった場合、プロパティは無視され、Cache インスタンスが CacheManager から取得されます。
メモ: Spring 5.0 以降、Spring の EhCache サポートには EhCache 2.10 以上が必要です。
導入:
1.1.1
作成者:
Juergen Hoeller, Dmitriy Kopylenko
関連事項:
setCacheManager(net.sf.ehcache.CacheManager), EhCacheManagerFactoryBean, Cache

ネストされたクラスのサマリー
- クラス net.sf.ehcache.config.CacheConfiguration から継承されたネストクラス / インターフェース
  CacheConfiguration.BootstrapCacheLoaderFactoryConfiguration, CacheConfiguration.CacheDecoratorFactoryConfiguration, CacheConfiguration.CacheEventListenerFactoryConfiguration, CacheConfiguration.CacheExceptionHandlerFactoryConfiguration, CacheConfiguration.CacheExtensionFactoryConfiguration, CacheConfiguration.CacheLoaderFactoryConfiguration, CacheConfiguration.TransactionalMode

フィールドサマリー
フィールド
修飾子と型フィールドと説明
protected Log logger
- クラス net.sf.ehcache.config.CacheConfiguration から継承されたフィールド
  bootstrapCacheLoaderFactoryConfiguration, cacheDecoratorConfigurations, cacheEventListenerConfigurations, cacheExceptionHandlerFactoryConfiguration, cacheExtensionConfigurations, cacheLoaderConfigurations, cacheLoaderTimeoutMillis, cacheWriterConfiguration, clearOnFlush, DEFAULT_CACHE_WRITER_CONFIGURATION, DEFAULT_CLEAR_ON_FLUSH, DEFAULT_COPY_ON_READ, DEFAULT_COPY_ON_WRITE, DEFAULT_COPY_STRATEGY_CONFIGURATION, DEFAULT_DISK_ACCESS_STRIPES, DEFAULT_DISK_PERSISTENT, DEFAULT_ETERNAL_VALUE, DEFAULT_EXPIRY_THREAD_INTERVAL_SECONDS, DEFAULT_LOGGING, DEFAULT_MAX_BYTES_OFF_HEAP, DEFAULT_MAX_BYTES_ON_DISK, DEFAULT_MAX_BYTES_ON_HEAP, DEFAULT_MAX_ELEMENTS_ON_DISK, DEFAULT_MAX_ENTRIES_IN_CACHE, DEFAULT_MEMORY_STORE_EVICTION_POLICY, DEFAULT_SPOOL_BUFFER_SIZE, DEFAULT_STATISTICS, DEFAULT_TRANSACTIONAL_MODE, DEFAULT_TTI, DEFAULT_TTL, diskAccessStripes, diskExpiryThreadIntervalSeconds, diskPersistent, diskSpoolBufferSizeMB, eternal, listeners, logging, maxElementsOnDisk, maxEntriesInCache, maxEntriesLocalHeap, memoryStoreEvictionPolicy, name, overflowToDisk, overflowToOffHeap, pinningConfiguration, terracottaConfiguration, timeToIdleSeconds, timeToLiveSeconds
- インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド
  OBJECT_TYPE_ATTRIBUTE

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

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
EhCacheFactoryBean()

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

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()` すべての Bean プロパティを設定し、`BeanFactoryAware`、`ApplicationContextAware` などを満たした後、包含 `BeanFactory` によって呼び出されます。
`protected Cache`	`createCache()` この FactoryBean の構成に基づいて生の Cache オブジェクトを作成します。
`protected Ehcache`	`decorateCache(Ehcache cache)` 必要に応じて、指定されたキャッシュを装飾します。
`Ehcache`	`getObject()` このファクトリによって管理されるオブジェクトのインスタンス（おそらく共有または独立）を返します。
`ClassSE<? extends Ehcache>`	`getObjectType()` `afterPropertiesSet()` によって編成された `createCache()` および `decorateCache(Ehcache)` のロジックに基づいて、`getObject()` から返される特定の `Ehcache` 実装を予測します。
`boolean`	`isSingleton()` このファクトリによって管理されるオブジェクトはシングルトンですか？つまり、`FactoryBean.getObject()` は常に同じオブジェクト（キャッシュ可能な参照）を返しますか？
`void`	`setBeanName(StringSE name)` この Bean を作成した Bean ファクトリで Bean の名前を設定します。
`void`	`setBlocking(boolean blocking)` リクエストされた要素が作成されるまで読み取り試行をブロックするブロッキングキャッシュを使用するかどうかを設定します。
`void`	`setBootstrapCacheLoader(BootstrapCacheLoader bootstrapCacheLoader)` 存在する場合、このキャッシュに EhCache `BootstrapCacheLoader` を設定します。
`void`	`setCacheEntryFactory(CacheEntryFactory cacheEntryFactory)` EhCache `CacheEntryFactory` を設定して、自己生成キャッシュに使用します。
`void`	`setCacheEventListeners(SetSE<CacheEventListener> cacheEventListeners)` このキャッシュに登録する EhCache `cache event listeners` を指定します。
`void`	`setCacheManager(CacheManager cacheManager)` 名前付きキャッシュインスタンスを取得する CacheManager を設定します。
`void`	`setCacheName(StringSE cacheName)` キャッシュインスタンスを取得または作成する名前を設定します。
`void`	`setDisabled(boolean disabled)` このキャッシュを無効としてマークする必要があるかどうかを設定します。
`void`	`setDiskSpoolBufferSize(int diskSpoolBufferSize)` ディスクスプールバッファーサイズ（MB 単位）を設定します。
`void`	`setTimeToIdle(int timeToIdle)` 時間をアイドルに設定します。
`void`	`setTimeToLive(int timeToLive)` 生存時間を設定します。

クラス net.sf.ehcache.config.CacheConfiguration から継承されたメソッド
addBootstrapCacheLoaderFactory, addCacheDecoratorFactory, addCacheEventListenerFactory, addCacheExceptionHandlerFactory, addCacheExtensionFactory, addCacheLoaderFactory, addCacheWriter, addConfigurationListener, addCopyStrategy, addDynamicSearchListener, addElementValueComparator, addPersistence, addPinning, addSearchable, addSizeOfPolicy, addTerracotta, bootstrapCacheLoaderFactory, cacheEventListenerFactory, cacheExceptionHandlerFactory, cacheExtensionFactory, cacheLoaderFactory, cacheWriter, clearOnFlush, clone, copyOnRead, copyOnWrite, diskAccessStripes, diskExpiryThreadIntervalSeconds, diskPersistent, diskSpoolBufferSizeMB, dynamicAttributeExtractor, eternal, freezeConfiguration, getBootstrapCacheLoaderFactoryConfiguration, getCacheDecoratorConfigurations, getCacheEventListenerConfigurations, getCacheExceptionHandlerFactoryConfiguration, getCacheExtensionConfigurations, getCacheLoaderConfigurations, getCacheLoaderTimeoutMillis, getCacheWriterConfiguration, getClassLoader, getCopyStrategy, getCopyStrategyConfiguration, getDiskAccessStripes, getDiskExpiryThreadIntervalSeconds, getDiskSpoolBufferSizeMB, getDynamicExtractor, getElementValueComparatorConfiguration, getLogging, getMaxBytesLocalDisk, getMaxBytesLocalDiskAsString, getMaxBytesLocalDiskPercentage, getMaxBytesLocalHeap, getMaxBytesLocalHeapAsString, getMaxBytesLocalHeapPercentage, getMaxBytesLocalOffHeap, getMaxBytesLocalOffHeapAsString, getMaxBytesLocalOffHeapPercentage, getMaxElementsInMemory, getMaxElementsOnDisk, getMaxEntriesInCache, getMaxEntriesLocalDisk, getMaxEntriesLocalHeap, getMaxMemoryOffHeap, getMaxMemoryOffHeapInBytes, getMemoryStoreEvictionPolicy, getName, getPersistenceConfiguration, getPinningConfiguration, getSearchable, getSearchAttributes, getSizeOfPolicyConfiguration, getStatistics, getTerracottaConfiguration, getTerracottaConsistency, getTimeToIdleSeconds, getTimeToLiveSeconds, getTransactionalMode, internalSetDiskCapacity, internalSetEternal, internalSetLogging, internalSetMaxBytesLocalOffheap, internalSetMaxEntriesInCache, internalSetMemCapacity, internalSetMemCapacityInBytes, internalSetOverflowToOffheap, internalSetTimeToIdle, internalSetTimeToLive, isClearOnFlush, isCopyOnRead, isCopyOnWrite, isCountBasedTuned, isDiskPersistent, isEternal, isFrozen, isLocalTransactional, isMaxBytesLocalDiskPercentageSet, isMaxBytesLocalHeapPercentageSet, isMaxBytesLocalOffHeapPercentageSet, isOverflowToDisk, isOverflowToOffHeap, isOverflowToOffHeapSet, isSearchable, isTerracottaClustered, isXaStrictTransactional, isXaTransactional, logging, maxBytesLocalDisk, maxBytesLocalHeap, maxBytesLocalOffHeap, maxElementsInMemory, maxElementsOnDisk, maxEntriesInCache, maxEntriesLocalDisk, maxEntriesLocalHeap, maxMemoryOffHeap, memoryStoreEvictionPolicy, memoryStoreEvictionPolicy, name, overflowToDisk, overflowToOffHeap, persistence, pinning, removeConfigurationListener, searchable, setCacheLoaderTimeoutMillis, setClassLoader, setClearOnFlush, setCopyOnRead, setCopyOnWrite, setDiskAccessStripes, setDiskExpiryThreadIntervalSeconds, setDiskPersistent, setDiskSpoolBufferSizeMB, setDynamicAttributesExtractor, setEternal, setLogging, setMaxBytesLocalDisk, setMaxBytesLocalDisk, setMaxBytesLocalHeap, setMaxBytesLocalHeap, setMaxBytesLocalOffHeap, setMaxBytesLocalOffHeap, setMaxElementsInMemory, setMaxElementsOnDisk, setMaxEntriesInCache, setMaxEntriesLocalDisk, setMaxEntriesLocalHeap, setMaxMemoryOffHeap, setMemoryStoreEvictionPolicy, setMemoryStoreEvictionPolicyFromObject, setName, setOverflowToDisk, setOverflowToOffHeap, setStatistics, setTimeToIdleSeconds, setTimeToLiveSeconds, setTransactionalMode, setupFor, setupFor, sizeOfPolicy, statistics, terracotta, timeoutMillis, timeToIdleSeconds, timeToLiveSeconds, transactionalMode, transactionalMode, validate, validateCompleteConfiguration, validateConfiguration

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

- フィールドの詳細
  - logger
```
protected final Log logger
```
- コンストラクターの詳細
  - EhCacheFactoryBean
```
public EhCacheFactoryBean()
```
- メソッドの詳細
  - setCacheManager
```
public void setCacheManager(CacheManager cacheManager)
```
    名前付きキャッシュインスタンスを取得する CacheManager を設定します。デフォルトでは、CacheManager.getInstance() が呼び出されます。
    特に永続キャッシュの場合は、CacheManager のシャットダウンを適切に処理することをお勧めします。別の EhCacheManagerFactoryBean をセットアップし、この Bean プロパティへの参照を渡します。
    EhCache 構成をデフォルト以外の構成場所からロードするには、別個の EhCacheManagerFactoryBean も必要です。
    関連事項:
    EhCacheManagerFactoryBean, CacheManager.getInstance()
  - setCacheName
```
public void setCacheName(StringSE cacheName)
```
    キャッシュインスタンスを取得または作成する名前を設定します。デフォルトは、この EhCacheFactoryBean の Bean 名です。
  - setTimeToLive
```
public void setTimeToLive(int timeToLive)
```
    生存時間を設定します。
    関連事項:
    CacheConfiguration.setTimeToLiveSeconds(long)
  - setTimeToIdle
```
public void setTimeToIdle(int timeToIdle)
```
    時間をアイドルに設定します。
    関連事項:
    CacheConfiguration.setTimeToIdleSeconds(long)
  - setDiskSpoolBufferSize
```
public void setDiskSpoolBufferSize(int diskSpoolBufferSize)
```
    ディスクスプールバッファーサイズ（MB 単位）を設定します。
    関連事項:
    CacheConfiguration.setDiskSpoolBufferSizeMB(int)
  - setBlocking
```
public void setBlocking(boolean blocking)
```
    リクエストされた要素が作成されるまで読み取り試行をブロックするブロッキングキャッシュを使用するかどうかを設定します。
    自己生成ブロッキングキャッシュを構築する場合は、CacheEntryFactory の指定を検討してください。
    関連事項:
    BlockingCache, setCacheEntryFactory(net.sf.ehcache.constructs.blocking.CacheEntryFactory)
  - setCacheEntryFactory
```
public void setCacheEntryFactory(CacheEntryFactory cacheEntryFactory)
```
    EhCache CacheEntryFactory を設定して、自己生成キャッシュに使用します。そのようなファクトリが指定されている場合、キャッシュは EhCache の SelfPopulatingCache で装飾されます。
    指定されたファクトリの型は UpdatingCacheEntryFactory にすることができ、これにより UpdatingSelfPopulatingCache が使用されます。
    メモ: そのような自己生成キャッシュは、自動的にブロッキングキャッシュになります。
    関連事項:
    SelfPopulatingCache, UpdatingSelfPopulatingCache, UpdatingCacheEntryFactory
  - setBootstrapCacheLoader
```
public void setBootstrapCacheLoader(BootstrapCacheLoader bootstrapCacheLoader)
```
    存在する場合、このキャッシュに EhCache BootstrapCacheLoader を設定します。
  - setCacheEventListeners
```
public void setCacheEventListeners(SetSE<CacheEventListener> cacheEventListeners)
```
    このキャッシュに登録する EhCache cache event listeners を指定します。
  - setDisabled
```
public void setDisabled(boolean disabled)
```
    このキャッシュを無効としてマークする必要があるかどうかを設定します。
    関連事項:
    Cache.setDisabled(boolean)
  - setBeanName
```
public void setBeanName(StringSE name)
```
    インターフェースからコピーされた説明: BeanNameAware
    この Bean を作成した Bean ファクトリで Bean の名前を設定します。
    通常の Bean プロパティの設定後、ただし InitializingBean.afterPropertiesSet() またはカスタム init メソッドなどの init コールバックの前に呼び出されます。
    次で指定:
    インターフェース BeanNameAware の setBeanName
    パラメーター:
    name - ファクトリ内の Bean の名前。この名前は、ファクトリで使用される実際の Bean 名であり、最初に指定した名前とは異なる場合があります。特に内部 Bean 名の場合、実際の Bean 名は "#..." サフィックスを追加することで一意になります。必要に応じて、BeanFactoryUtils.originalBeanName(String) メソッドを使用して、元の Bean 名（サフィックスなし）を抽出します。
  - afterPropertiesSet
```
public void afterPropertiesSet()
                        throws CacheException
```
    インターフェースからコピーされた説明: InitializingBean
    すべての Bean プロパティを設定し、BeanFactoryAware、ApplicationContextAware などを満たした後、包含 BeanFactory によって呼び出されます。
    このメソッドにより、Bean インスタンスは、すべての Bean プロパティが設定されたときに、その全体的な構成の検証と最終的な初期化を実行できます。
    次で指定:
    インターフェース InitializingBean の afterPropertiesSet
    例外:
    CacheException
  - createCache
```
protected Cache createCache()
```
    この FactoryBean の構成に基づいて生の Cache オブジェクトを作成します。
  - decorateCache
```
protected Ehcache decorateCache(Ehcache cache)
```
    必要に応じて、指定されたキャッシュを装飾します。
    パラメーター:
    cache - この FactoryBean の構成に基づいた生の Cache オブジェクト
    戻り値:
    CacheManager に登録される（装飾される可能性のある）キャッシュオブジェクト
  - getObject
```
@Nullable
public Ehcache getObject()
```
    インターフェースからコピーされた説明: FactoryBean
    このファクトリによって管理されるオブジェクトのインスタンス（おそらく共有または独立）を返します。
    BeanFactory と同様に、これにより、シングルトンとプロトタイプの両方のデザインパターンをサポートできます。
    この FactoryBean が呼び出し時にまだ完全に初期化されていない場合（たとえば、循環参照に関係しているため）、対応する FactoryBeanNotInitializedException をスローします。
    Spring 2.0 以降、FactoryBeans は null オブジェクトを返すことができます。ファクトリはこれを通常の値として使用します。この場合、FactoryBeanNotInitializedException はスローされません。FactoryBean の実装では、必要に応じて FactoryBeanNotInitializedException 自体をすぐにスローすることをお勧めします。
    次で指定:
    インターフェース FactoryBean<Ehcache> の getObject
    戻り値:
    Bean のインスタンス (null にすることができます)
    関連事項:
    FactoryBeanNotInitializedException
  - getObjectType
```
public ClassSE<? extends Ehcache> getObjectType()
```
    afterPropertiesSet() によって編成された createCache() および decorateCache(Ehcache) のロジックに基づいて、getObject() から返される特定の Ehcache 実装を予測します。
    次で指定:
    インターフェース FactoryBean<Ehcache> の 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<Ehcache> の isSingleton
    戻り値:
    公開されたオブジェクトがシングルトンかどうか
    関連事項:
    FactoryBean.getObject(), SmartFactoryBean.isPrototype()

クラス EhCacheFactoryBean

ネストされたクラスのサマリー

クラス net.sf.ehcache.config.CacheConfiguration から継承されたネストクラス / インターフェース

フィールドサマリー

クラス net.sf.ehcache.config.CacheConfiguration から継承されたフィールド

インターフェース org.springframework.beans.factory.FactoryBean から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス net.sf.ehcache.config.CacheConfiguration から継承されたメソッド

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

フィールドの詳細

logger

コンストラクターの詳細

EhCacheFactoryBean

メソッドの詳細

setCacheManager

setCacheName

setTimeToLive

setTimeToIdle

setDiskSpoolBufferSize

setBlocking

setCacheEntryFactory

setBootstrapCacheLoader

setCacheEventListeners

setDisabled

setBeanName

afterPropertiesSet

createCache

decorateCache

getObject

getObjectType

isSingleton