クラス RedisCacheManager.RedisCacheManagerBuilder
java.lang.ObjectSE
org.springframework.data.redis.cache.RedisCacheManager.RedisCacheManagerBuilder
- 含まれているクラス:
- RedisCacheManager
RedisCacheManager
を作成するためのビルダー。- 導入:
- 2.0
- 作成者:
- Christoph Strobl, Mark Paluch, Kezhu Wang, John Blum
メソッドのサマリー
修飾子と型メソッド説明allowCreateOnMissingCache
(boolean allowRuntimeCacheCreation) 実行時にキャッシュの作成を許可するかどうかを構成します。build()
構成オプションを適用して、RedisCacheManager
の新しいインスタンスを作成します。デフォルトのRedisCacheConfiguration
を返します。cacheDefaults
(RedisCacheConfiguration defaultCacheConfiguration) 動的に作成されたRedisCache
に適用されるデフォルトのRedisCacheConfiguration
を定義します。cacheWriter
(RedisCacheWriter cacheWriter) RedisCacheWriter
を構成します。未構成、未宣言のキャッシュについては、実行時のRedisCache
作成を無効にします。未構成、未宣言のキャッシュに対して実行時にRedisCache
を作成できるようにします。キャッシュ統計を有効にします。fromCacheWriter
(RedisCacheWriter cacheWriter) 指定されたRedisCacheWriter
を使用してRedisCacheManager
を作成および構成するために使用される新しい Builder を返すファクトリメソッド。fromConnectionFactory
(RedisConnectionFactory connectionFactory) 指定されたRedisConnectionFactory
を使用してRedisCacheManager
を作成および構成するために使用される新しい Builder を返すファクトリメソッド。getCacheConfigurationFor
(StringSE cacheName) 指定されたキャッシュのRedisCacheConfiguration
をその名前で取得します。ビルダーがconfiguration
を保持しているキャッシュ名のSet
SE を取得します。initialCacheNames
(SetSE<StringSE> cacheNames) 現在のRedisCacheConfiguration
で事前に初期化されるキャッシュ名のSet
SE を追加します。RedisCache
を有効にして、キャッシュのプット / エビクト操作を進行中の Spring 管理トランザクションと同期させます。withCacheConfiguration
(StringSE cacheName, RedisCacheConfiguration cacheConfiguration) withInitialCacheConfigurations
(MapSE<StringSE, RedisCacheConfiguration> cacheConfigurations) 事前に初期化するキャッシュ名 /RedisCacheConfiguration
ペアのMap
SE を追加します。
メソッドの詳細
fromCacheWriter
public static RedisCacheManager.RedisCacheManagerBuilder fromCacheWriter(RedisCacheWriter cacheWriter) 指定されたRedisCacheWriter
を使用してRedisCacheManager
を作成および構成するために使用される新しい Builder を返すファクトリメソッド。- パラメーター:
cacheWriter
-RedisCacheWriter
は、適切な Redis コマンドを実行することでRedisCache
操作を実行していました。null であってはなりません。- 戻り値:
- 新しい
RedisCacheManager.RedisCacheManagerBuilder
。 - 例外:
IllegalArgumentExceptionSE
- 指定されたRedisCacheWriter
が null の場合。- 関連事項:
fromConnectionFactory
public static RedisCacheManager.RedisCacheManagerBuilder fromConnectionFactory(RedisConnectionFactory connectionFactory) 指定されたRedisConnectionFactory
を使用してRedisCacheManager
を作成および構成するために使用される新しい Builder を返すファクトリメソッド。- パラメーター:
connectionFactory
-RedisConnectionFactory
は、RedisCache
操作の実行時に Redis への接続を取得するためにRedisCacheManager
によって使用されます。null であってはなりません。- 戻り値:
- 新しい
RedisCacheManager.RedisCacheManagerBuilder
。 - 例外:
IllegalArgumentExceptionSE
- 指定されたRedisConnectionFactory
が null の場合。- 関連事項:
allowCreateOnMissingCache
public RedisCacheManager.RedisCacheManagerBuilder allowCreateOnMissingCache(boolean allowRuntimeCacheCreation) 実行時にキャッシュの作成を許可するかどうかを構成します。- パラメーター:
allowRuntimeCacheCreation
- 実行時に宣言されていないキャッシュの作成を許可するブール値。デフォルトでは true です。- 戻り値:
- この
RedisCacheManager.RedisCacheManagerBuilder
。
disableCreateOnMissingCache
未構成、未宣言のキャッシュについては、実行時のRedisCache
作成を無効にします。RedisCacheManager.getMissingCache(String)
は、新しいRedisCache
インスタンスではなく、未構成、未宣言のCache
に対して null を返します。これにより、CompositeCacheManager
が参加できるようになります。enableCreateOnMissingCache
未構成、未宣言のキャッシュに対して実行時にRedisCache
を作成できるようにします。cacheDefaults
デフォルトのRedisCacheConfiguration
を返します。- 戻り値:
- デフォルトの
RedisCacheConfiguration
。
cacheDefaults
public RedisCacheManager.RedisCacheManagerBuilder cacheDefaults(RedisCacheConfiguration defaultCacheConfiguration) 動的に作成されたRedisCache
に適用されるデフォルトのRedisCacheConfiguration
を定義します。- パラメーター:
defaultCacheConfiguration
- null であってはなりません。- 戻り値:
- この
RedisCacheManager.RedisCacheManagerBuilder
。
cacheWriter
RedisCacheWriter
を構成します。- パラメーター:
cacheWriter
- null であってはなりません。- 戻り値:
- この
RedisCacheManager.RedisCacheManagerBuilder
。 - 導入:
- 2.3
enableStatistics
キャッシュ統計を有効にします。initialCacheNames
現在のRedisCacheConfiguration
で事前に初期化されるキャッシュ名のSet
SE を追加します。注 : この呼び出しは、このメソッドの呼び出し時に存在するデフォルトのRedisCacheConfiguration
を使用するcacheDefaults(RedisCacheConfiguration)
に依存します。- パラメーター:
cacheNames
- null であってはなりません。- 戻り値:
- この
RedisCacheManager.RedisCacheManagerBuilder
。
transactionAware
RedisCache
を有効にして、キャッシュのプット / エビクト操作を進行中の Spring 管理トランザクションと同期させます。withCacheConfiguration
public RedisCacheManager.RedisCacheManagerBuilder withCacheConfiguration(StringSE cacheName, RedisCacheConfiguration cacheConfiguration) - パラメーター:
cacheName
- 起動時に作成するために登録するキャッシュのname
SE。cacheConfiguration
-RedisCacheConfiguration
は、起動時に新しいキャッシュを構成するために使用されます。- 戻り値:
- この
RedisCacheManager.RedisCacheManagerBuilder
。 - 導入:
- 2.2
withInitialCacheConfigurations
public RedisCacheManager.RedisCacheManagerBuilder withInitialCacheConfigurations(MapSE<StringSE, RedisCacheConfiguration> cacheConfigurations) 事前に初期化するキャッシュ名 /RedisCacheConfiguration
ペアのMap
SE を追加します。- パラメーター:
cacheConfigurations
- null であってはなりません。- 戻り値:
- この
RedisCacheManager.RedisCacheManagerBuilder
。
getCacheConfigurationFor
指定されたキャッシュのRedisCacheConfiguration
をその名前で取得します。- パラメーター:
cacheName
- null であってはなりません。- 戻り値:
- 指定されたキャッシュ名に
RedisCacheConfiguration
が設定されていない場合はOptional.empty()
。 - 導入:
- 2.2
getConfiguredCaches
ビルダーがconfiguration
を保持しているキャッシュ名のSet
SE を取得します。- 戻り値:
configuration
が設定されているキャッシュの名前を保持する変更不可能なSet
SE。- 導入:
- 2.2
build
構成オプションを適用して、RedisCacheManager
の新しいインスタンスを作成します。- 戻り値:
RedisCacheManager
の新しいインスタンス。