Package org.infinispan.configuration.cache

Class InterceptorConfigurationBuilder

java.lang.Object

org.infinispan.configuration.cache.AbstractCustomInterceptorsConfigurationChildBuilder

org.infinispan.configuration.cache.InterceptorConfigurationBuilder

All Implemented Interfaces:

Builder<InterceptorConfiguration>, ConfigurationChildBuilder

@Deprecated(forRemoval=true)
public class InterceptorConfigurationBuilder
extends AbstractCustomInterceptorsConfigurationChildBuilder
implements Builder<InterceptorConfiguration>

Deprecated, for removal: This API element is subject to removal in a future version.

Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors

This builder defines details of a specific custom interceptor.

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConfigurationBuilder	builder

Method Summary

Modifier and Type	Method	Description
InterceptorConfigurationBuilder	addProperty(String key, String value)	Deprecated, for removal: This API element is subject to removal in a future version.
InterceptorConfigurationBuilder	after(Class<? extends AsyncInterceptor> after)	Deprecated, for removal: This API element is subject to removal in a future version. Dictates that the custom interceptor appears immediately after the specified interceptor.
AttributeSet	attributes()	Deprecated, for removal: This API element is subject to removal in a future version.
InterceptorConfigurationBuilder	before(Class<? extends AsyncInterceptor> before)	Deprecated, for removal: This API element is subject to removal in a future version. Dictates that the custom interceptor appears immediately before the specified interceptor.
Configuration	build()
InterceptorConfigurationBuilder	clearProperties()	Deprecated, for removal: This API element is subject to removal in a future version. Clears the interceptor properties
ClusteringConfigurationBuilder	clustering()
InterceptorConfiguration	create()	Deprecated, for removal: This API element is subject to removal in a future version. Create the configuration bean
CustomInterceptorsConfigurationBuilder	customInterceptors()	Deprecated, for removal: This API element is subject to removal in a future version. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
EncodingConfigurationBuilder	encoding()
ExpirationConfigurationBuilder	expiration()
protected ConfigurationBuilder	getBuilder()
InterceptorConfigurationBuilder	index(int i)	Deprecated, for removal: This API element is subject to removal in a future version. Specifies a position in the interceptor chain to place the new interceptor.
IndexingConfigurationBuilder	indexing()
InterceptorConfigurationBuilder	interceptor(AsyncInterceptor interceptor)	Deprecated, for removal: This API element is subject to removal in a future version. An instance of the new custom interceptor to add to the configuration.
InterceptorConfigurationBuilder	interceptorClass(Class<? extends AsyncInterceptor> interceptorClass)	Deprecated, for removal: This API element is subject to removal in a future version. Class of the new custom interceptor to add to the configuration.
InvocationBatchingConfigurationBuilder	invocationBatching()
LockingConfigurationBuilder	locking()
MemoryConfigurationBuilder	memory()
PersistenceConfigurationBuilder	persistence()
InterceptorConfigurationBuilder	position(InterceptorConfiguration.Position p)	Deprecated, for removal: This API element is subject to removal in a future version. Specifies a position, denoted by the InterceptorConfiguration.Position enumeration, where to place the new interceptor.
QueryConfigurationBuilder	query()
InterceptorConfigurationBuilder	read(InterceptorConfiguration template, Combine combine)	Deprecated, for removal: This API element is subject to removal in a future version. Reads the configuration from an already created configuration bean into this builder.
InterceptorConfigurationBuilder	removeProperty(String key)	Deprecated, for removal: This API element is subject to removal in a future version.
SecurityConfigurationBuilder	security()
boolean	simpleCache()
ConfigurationChildBuilder	simpleCache(boolean simpleCache)
SitesConfigurationBuilder	sites()
StatisticsConfigurationBuilder	statistics()
ConfigurationChildBuilder	template(boolean template)
String	toString()	Deprecated, for removal: This API element is subject to removal in a future version.
TransactionConfigurationBuilder	transaction()
UnsafeConfigurationBuilder	unsafe()
void	validate()	Deprecated, for removal: This API element is subject to removal in a future version. Validate the data in this builder before building the configuration bean
void	validate(GlobalConfiguration globalConfig)	Deprecated, for removal: This API element is subject to removal in a future version.
InterceptorConfigurationBuilder	withProperties(Properties properties)	Deprecated, for removal: This API element is subject to removal in a future version. 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

Methods inherited from interface org.infinispan.commons.configuration.Builder

read, reset

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder

jmxStatistics

Field Details

builder

protected final ConfigurationBuilder builder

Method Details

attributes

public AttributeSet attributes()

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

attributes in interface Builder<InterceptorConfiguration>

after

public InterceptorConfigurationBuilder after(Class<? extends AsyncInterceptor> after)

Deprecated, for removal: This API element is subject to removal in a future version.

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)

Deprecated, for removal: This API element is subject to removal in a future version.

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)

Deprecated, for removal: This API element is subject to removal in a future version.

Class of the new custom interceptor to add to the configuration.

Parameters:

interceptorClass - an instance of AsyncInterceptor

interceptor

public InterceptorConfigurationBuilder interceptor(AsyncInterceptor interceptor)

Deprecated, for removal: This API element is subject to removal in a future version.

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)

Deprecated, for removal: This API element is subject to removal in a future version.

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)

Deprecated, for removal: This API element is subject to removal in a future version.

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)

Deprecated, for removal: This API element is subject to removal in a future version.

Sets interceptor properties

Returns:

this InterceptorConfigurationBuilder

clearProperties

public InterceptorConfigurationBuilder clearProperties()

Deprecated, for removal: This API element is subject to removal in a future version.

Clears the interceptor properties

Returns:

this InterceptorConfigurationBuilder

addProperty

public InterceptorConfigurationBuilder addProperty(String key,
 String value)

Deprecated, for removal: This API element is subject to removal in a future version.

removeProperty

public InterceptorConfigurationBuilder removeProperty(String key)

Deprecated, for removal: This API element is subject to removal in a future version.

validate

public void validate()

Deprecated, for removal: This API element is subject to removal in a future version.

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)

Deprecated, for removal: This API element is subject to removal in a future version.

Specified by:

validate in interface ConfigurationChildBuilder

create

public InterceptorConfiguration create()

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<InterceptorConfiguration>

Returns:

read

public InterceptorConfigurationBuilder read(InterceptorConfiguration template,
 Combine combine)

Deprecated, for removal: This API element is subject to removal in a future version.

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.

combine - the way attributes and children of this instance and the template should be combined.

toString

public String toString()

Deprecated, for removal: This API element is subject to removal in a future version.

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

@Deprecated(forRemoval=true)
public CustomInterceptorsConfigurationBuilder customInterceptors()

Deprecated, for removal: This API element is subject to removal in a future version.

Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors

Specified by:

customInterceptors in interface ConfigurationChildBuilder

encoding

public EncodingConfigurationBuilder encoding()

Specified by:

encoding in interface ConfigurationChildBuilder

expiration

public ExpirationConfigurationBuilder expiration()

Specified by:

expiration in interface ConfigurationChildBuilder

query

public QueryConfigurationBuilder query()

Specified by:

query in interface ConfigurationChildBuilder

indexing

public IndexingConfigurationBuilder indexing()

Specified by:

indexing in interface ConfigurationChildBuilder

invocationBatching

public InvocationBatchingConfigurationBuilder invocationBatching()

Specified by:

invocationBatching in interface ConfigurationChildBuilder

statistics

public StatisticsConfigurationBuilder statistics()

Specified by:

statistics 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

transaction

public TransactionConfigurationBuilder transaction()

Specified by:

transaction in interface ConfigurationChildBuilder

unsafe

public UnsafeConfigurationBuilder unsafe()

Specified by:

unsafe in interface ConfigurationChildBuilder

sites

public SitesConfigurationBuilder sites()

Specified by:

sites 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