InterceptorConfigurationBuilder (Infinispan JavaDoc All 9.0.3.Final API)

java.lang.Object
- org.infinispan.configuration.cache.AbstractCustomInterceptorsConfigurationChildBuilder
- - org.infinispan.configuration.cache.InterceptorConfigurationBuilder

All Implemented Interfaces:: Builder<InterceptorConfiguration>, ConfigurationChildBuilder

public class InterceptorConfigurationBuilder
extends AbstractCustomInterceptorsConfigurationChildBuilder
implements Builder<InterceptorConfiguration>

This builder defines details of a specific custom interceptor.

Field Summary

Fields
Modifier and Type Field and Description

protected ConfigurationBuilder builder

Fields
Modifier and Type	Field and Description
`protected ConfigurationBuilder`	`builder`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`InterceptorConfigurationBuilder`	`addProperty(String key, String value)`
`InterceptorConfigurationBuilder`	`after(Class<? extends AsyncInterceptor> after)` Dictates that the custom interceptor appears immediately after the specified interceptor.
`InterceptorConfigurationBuilder`	`before(Class<? extends AsyncInterceptor> before)` Dictates that the custom interceptor appears immediately before the specified interceptor.
`Configuration`	`build()`
`InterceptorConfigurationBuilder`	`clearProperties()` Clears the interceptor properties
`ClusteringConfigurationBuilder`	`clustering()`
`CompatibilityModeConfigurationBuilder`	`compatibility()`
`InterceptorConfiguration`	`create()` Create the configuration bean
`CustomInterceptorsConfigurationBuilder`	`customInterceptors()`
`DataContainerConfigurationBuilder`	`dataContainer()`
`DeadlockDetectionConfigurationBuilder`	`deadlockDetection()`
`EvictionConfigurationBuilder`	`eviction()`
`ExpirationConfigurationBuilder`	`expiration()`
`protected ConfigurationBuilder`	`getBuilder()`
`InterceptorConfigurationBuilder`	`index(int i)` Specifies a position in the interceptor chain to place the new interceptor.
`IndexingConfigurationBuilder`	`indexing()`
`InterceptorConfigurationBuilder`	`interceptor(AsyncInterceptor interceptor)` An instance of the new custom interceptor to add to the configuration.
`InterceptorConfigurationBuilder`	`interceptor(CommandInterceptor interceptor)` Deprecated. Since 9.0, please use `interceptor(AsyncInterceptor)` instead.
`InterceptorConfigurationBuilder`	`interceptorClass(Class<? extends AsyncInterceptor> interceptorClass)` Class of the new custom interceptor to add to the configuration.
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`JMXStatisticsConfigurationBuilder`	`jmxStatistics()`
`LockingConfigurationBuilder`	`locking()`
`MemoryConfigurationBuilder`	`memory()`
`PersistenceConfigurationBuilder`	`persistence()`
`InterceptorConfigurationBuilder`	`position(InterceptorConfiguration.Position p)` Specifies a position, denoted by the `InterceptorConfiguration.Position` enumeration, where to place the new interceptor.
`InterceptorConfigurationBuilder`	`read(InterceptorConfiguration template)` Reads the configuration from an already created configuration bean into this builder.
`InterceptorConfigurationBuilder`	`removeProperty(String key)`
`SecurityConfigurationBuilder`	`security()`
`boolean`	`simpleCache()`
`ConfigurationChildBuilder`	`simpleCache(boolean simpleCache)`
`SitesConfigurationBuilder`	`sites()`
`StoreAsBinaryConfigurationBuilder`	`storeAsBinary()`
`ConfigurationChildBuilder`	`template(boolean template)`
`String`	`toString()`
`TransactionConfigurationBuilder`	`transaction()`
`UnsafeConfigurationBuilder`	`unsafe()`
`void`	`validate()` Validate the data in this builder before building the configuration bean
`void`	`validate(GlobalConfiguration globalConfig)`
`VersioningConfigurationBuilder`	`versioning()`
`InterceptorConfigurationBuilder`	`withProperties(Properties properties)` Sets interceptor properties

Methods inherited from class org.infinispan.configuration.cache.AbstractCustomInterceptorsConfigurationChildBuilder
getCustomInterceptorsBuilder

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - builder
```
protected final ConfigurationBuilder builder
```
- Method Detail
  - after
```
public InterceptorConfigurationBuilder after(Class<? extends AsyncInterceptor> after)
```
    Dictates that the custom interceptor appears immediately after the specified interceptor. If the specified interceptor is not found in the interceptor chain, a CacheConfigurationException will be thrown when the cache starts.
    
    Parameters:
    
    after - the class of the interceptor to look for
  - before
```
public InterceptorConfigurationBuilder before(Class<? extends AsyncInterceptor> before)
```
    Dictates that the custom interceptor appears immediately before the specified interceptor. If the specified interceptor is not found in the interceptor chain, a CacheConfigurationException will be thrown when the cache starts.
    
    Parameters:
    
    before - the class of the interceptor to look for
  - interceptorClass
```
public InterceptorConfigurationBuilder interceptorClass(Class<? extends AsyncInterceptor> interceptorClass)
```
    Class of the new custom interceptor to add to the configuration.
    
    Parameters:
    
    interceptorClass - an instance of AsyncInterceptor
  - interceptor
```
@Deprecated
public InterceptorConfigurationBuilder interceptor(CommandInterceptor interceptor)
```
    Deprecated. Since 9.0, please use interceptor(AsyncInterceptor) instead.
  - interceptor
```
public InterceptorConfigurationBuilder interceptor(AsyncInterceptor interceptor)
```
    An instance of the new custom interceptor to add to the configuration. Warning: if you use this configuration for multiple caches, the interceptor instance will be shared, which will corrupt interceptor stack. Use interceptorClass(java.lang.Class<? extends org.infinispan.interceptors.AsyncInterceptor>) instead.
    
    Parameters:
    
    interceptor - an instance of AsyncInterceptor
  - index
```
public InterceptorConfigurationBuilder index(int i)
```
    Specifies a position in the interceptor chain to place the new interceptor. The index starts at 0 and goes up to the number of interceptors in a given configuration. An IllegalArgumentException is thrown if the index is less than 0 or greater than the maximum number of interceptors in the chain.
    
    Parameters:
    
    i - positional index in the interceptor chain to place the new interceptor.
  - position
```
public InterceptorConfigurationBuilder position(InterceptorConfiguration.Position p)
```
    Specifies a position, denoted by the InterceptorConfiguration.Position enumeration, where to place the new interceptor.
    
    Parameters:
    
    p - position to place the new interceptor
  - withProperties
```
public InterceptorConfigurationBuilder withProperties(Properties properties)
```
    Sets interceptor properties
    
    Returns:
    
    this InterceptorConfigurationBuilder
  - clearProperties
```
public InterceptorConfigurationBuilder clearProperties()
```
    Clears the interceptor properties
    
    Returns:
    
    this InterceptorConfigurationBuilder
  - addProperty
```
public InterceptorConfigurationBuilder addProperty(String key,
                                                   String value)
```
  - removeProperty
```
public InterceptorConfigurationBuilder removeProperty(String key)
```
  - validate
```
public void validate()
```
    Description copied from interface: Builder
    
    Validate the data in this builder before building the configuration bean
    
    Specified by:
    
    validate in interface Builder<InterceptorConfiguration>
  - validate
```
public void validate(GlobalConfiguration globalConfig)
```
    Specified by:
    
    validate in interface ConfigurationChildBuilder
  - create
```
public InterceptorConfiguration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Specified by:
    
    create in interface Builder<InterceptorConfiguration>
    
    Returns:
  - read
```
public InterceptorConfigurationBuilder read(InterceptorConfiguration template)
```
    Description copied from interface: Builder
    
    Reads the configuration from an already created configuration bean into this builder. Returns an appropriate builder to allow fluent configuration
    
    Specified by:
    
    read in interface Builder<InterceptorConfiguration>
    
    Parameters:
    
    template - the configuration from which to "clone" this config if needed.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - template
```
public ConfigurationChildBuilder template(boolean template)
```
    Specified by:
    
    template in interface ConfigurationChildBuilder
  - simpleCache
```
public ConfigurationChildBuilder simpleCache(boolean simpleCache)
```
    Specified by:
    
    simpleCache in interface ConfigurationChildBuilder
  - simpleCache
```
public boolean simpleCache()
```
    Specified by:
    
    simpleCache in interface ConfigurationChildBuilder
  - clustering
```
public ClusteringConfigurationBuilder clustering()
```
    Specified by:
    
    clustering in interface ConfigurationChildBuilder
  - customInterceptors
```
public CustomInterceptorsConfigurationBuilder customInterceptors()
```
    Specified by:
    
    customInterceptors in interface ConfigurationChildBuilder
  - dataContainer
```
public DataContainerConfigurationBuilder dataContainer()
```
    Specified by:
    
    dataContainer in interface ConfigurationChildBuilder
  - deadlockDetection
```
public DeadlockDetectionConfigurationBuilder deadlockDetection()
```
    Specified by:
    
    deadlockDetection in interface ConfigurationChildBuilder
  - eviction
```
public EvictionConfigurationBuilder eviction()
```
    Specified by:
    
    eviction in interface ConfigurationChildBuilder
  - expiration
```
public ExpirationConfigurationBuilder expiration()
```
    Specified by:
    
    expiration in interface ConfigurationChildBuilder
  - indexing
```
public IndexingConfigurationBuilder indexing()
```
    Specified by:
    
    indexing in interface ConfigurationChildBuilder
  - invocationBatching
```
public InvocationBatchingConfigurationBuilder invocationBatching()
```
    Specified by:
    
    invocationBatching in interface ConfigurationChildBuilder
  - jmxStatistics
```
public JMXStatisticsConfigurationBuilder jmxStatistics()
```
    Specified by:
    
    jmxStatistics in interface ConfigurationChildBuilder
  - persistence
```
public PersistenceConfigurationBuilder persistence()
```
    Specified by:
    
    persistence in interface ConfigurationChildBuilder
  - locking
```
public LockingConfigurationBuilder locking()
```
    Specified by:
    
    locking in interface ConfigurationChildBuilder
  - security
```
public SecurityConfigurationBuilder security()
```
    Specified by:
    
    security in interface ConfigurationChildBuilder
  - storeAsBinary
```
public StoreAsBinaryConfigurationBuilder storeAsBinary()
```
    Specified by:
    
    storeAsBinary in interface ConfigurationChildBuilder
  - transaction
```
public TransactionConfigurationBuilder transaction()
```
    Specified by:
    
    transaction in interface ConfigurationChildBuilder
  - versioning
```
public VersioningConfigurationBuilder versioning()
```
    Specified by:
    
    versioning in interface ConfigurationChildBuilder
  - unsafe
```
public UnsafeConfigurationBuilder unsafe()
```
    Specified by:
    
    unsafe in interface ConfigurationChildBuilder
  - sites
```
public SitesConfigurationBuilder sites()
```
    Specified by:
    
    sites in interface ConfigurationChildBuilder
  - compatibility
```
public CompatibilityModeConfigurationBuilder compatibility()
```
    Specified by:
    
    compatibility in interface ConfigurationChildBuilder
  - memory
```
public MemoryConfigurationBuilder memory()
```
    Specified by:
    
    memory in interface ConfigurationChildBuilder
  - getBuilder
```
protected ConfigurationBuilder getBuilder()
```
  - build
```
public Configuration build()
```
    Specified by:
    
    build in interface ConfigurationChildBuilder

Class InterceptorConfigurationBuilder

Field Summary

Method Summary

Methods inherited from class org.infinispan.configuration.cache.AbstractCustomInterceptorsConfigurationChildBuilder

Methods inherited from class java.lang.Object

Field Detail

builder

Method Detail

after

before

interceptorClass

interceptor

interceptor

index

position

withProperties

clearProperties

addProperty

removeProperty

validate

validate

create

read

toString

template

simpleCache

simpleCache

clustering

customInterceptors

dataContainer

deadlockDetection

eviction

expiration

indexing

invocationBatching

jmxStatistics

persistence

locking

security

storeAsBinary

transaction

versioning

unsafe

sites

compatibility

memory

getBuilder

build