Package org.infinispan.configuration.global

Class SerializationConfigurationBuilder

java.lang.Object

org.infinispan.configuration.global.SerializationConfigurationBuilder

All Implemented Interfaces:

Builder<SerializationConfiguration>, GlobalConfigurationChildBuilder

public class SerializationConfigurationBuilder
extends Object
implements Builder<SerializationConfiguration>

Configures serialization and marshalling settings.

Method Summary

Modifier and Type	Method	Description
<T> SerializationConfigurationBuilder	addAdvancedExternalizer(int id, AdvancedExternalizer<T> advancedExternalizer)	Deprecated, for removal: This API element is subject to removal in a future version. since 10.0, AdvancedExternalizer's will be removed in a future release.
<T> SerializationConfigurationBuilder	addAdvancedExternalizer(AdvancedExternalizer<T> advancedExternalizer)	Deprecated, for removal: This API element is subject to removal in a future version. since 10.0, AdvancedExternalizer's will be removed in a future release.
<T> SerializationConfigurationBuilder	addAdvancedExternalizer(AdvancedExternalizer<T>... advancedExternalizers)	Deprecated, for removal: This API element is subject to removal in a future version. since 10.0, AdvancedExternalizer's will be removed in a future release.
SerializationConfigurationBuilder	addContextInitializer(org.infinispan.protostream.SerializationContextInitializer sci)
SerializationConfigurationBuilder	addContextInitializers(List<org.infinispan.protostream.SerializationContextInitializer> scis)
SerializationConfigurationBuilder	addContextInitializers(org.infinispan.protostream.SerializationContextInitializer... scis)
AllowListConfigurationBuilder	allowList()
ThreadPoolConfigurationBuilder	asyncThreadPool()	Configuration for the asynchronous operations thread pool
AttributeSet	attributes()
ThreadPoolConfigurationBuilder	blockingThreadPool()	Configuration for the blocking thread pool
GlobalConfiguration	build()	Builds a GlobalConfiguration object using the settings applied to this builder
SerializationConfiguration	create()	Create the configuration bean
GlobalConfigurationBuilder	defaultCacheName(String defaultCacheName)	Sets the name of the cache that acts as the default cache and is returned by EmbeddedCacheManager.getCache().
ThreadPoolConfigurationBuilder	expirationThreadPool()	Configuration for the expiration thread pool
protected GlobalConfigurationBuilder	getGlobalConfig()
Marshaller	getMarshaller()
GlobalStateConfigurationBuilder	globalState()	Global state configuration
GlobalJmxConfigurationBuilder	jmx()	Global JMX configuration.
ThreadPoolConfigurationBuilder	listenerThreadPool()	Configuration for the listener thread pool
SerializationConfigurationBuilder	marshaller(Marshaller marshaller)	Set the marshaller instance that will marshall and unmarshall cache entries.
GlobalMetricsConfigurationBuilder	metrics()	Global metrics configuration.
List<Builder<?>>	modules()	Global modules configuration
ThreadPoolConfigurationBuilder	nonBlockingThreadPool()	Configuration for the non blocking thread pool
ThreadPoolConfigurationBuilder	persistenceThreadPool()	Configuration for the persistence thread pool
SerializationConfigurationBuilder	read(SerializationConfiguration template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
SerializationConfigurationBuilder	schemaCompatibilityValidation(org.infinispan.protostream.config.Configuration.SchemaValidation schemaValidation)
GlobalSecurityConfigurationBuilder	security()	Security-related configuration
SerializationConfigurationBuilder	serialization()	Global serialization (i.e.
ShutdownConfigurationBuilder	shutdown()	Shutdown configuration
SiteConfigurationBuilder	site()	Cross-site replication configuration
String	toString()
GlobalTracingConfigurationBuilder	tracing()	Global tracing configuration.
TransportConfigurationBuilder	transport()	Transport-related (i.e.
void	validate()	Validate the data in this builder before building the configuration bean
WhiteListConfigurationBuilder	whiteList()	Deprecated, for removal: This API element is subject to removal in a future version. since 12.0.

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

Method Details

attributes

public AttributeSet attributes()

Specified by:

attributes in interface Builder<SerializationConfiguration>

marshaller

public SerializationConfigurationBuilder marshaller(Marshaller marshaller)

Set the marshaller instance that will marshall and unmarshall cache entries.

Parameters:

marshaller -

getMarshaller

public Marshaller getMarshaller()

addAdvancedExternalizer

@Deprecated(forRemoval=true,
            since="10.0")
public <T> SerializationConfigurationBuilder addAdvancedExternalizer(int id,
 AdvancedExternalizer<T> advancedExternalizer)

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

since 10.0, AdvancedExternalizer's will be removed in a future release. Please utilise ProtoStream annotations on Java objects instead by configuring a SerializationContextInitializer via addContextInitializer(SerializationContextInitializer), or specifying a custom marshaller for user types via marshaller(Marshaller).

Helper method that allows for quick registration of an AdvancedExternalizer implementation alongside its corresponding identifier. Remember that the identifier needs to a be positive number, including 0, and cannot clash with other identifiers in the system.

Parameters:

id -

advancedExternalizer -

addAdvancedExternalizer

@Deprecated(forRemoval=true,
            since="10.0")
public <T> SerializationConfigurationBuilder addAdvancedExternalizer(AdvancedExternalizer<T> advancedExternalizer)

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

since 10.0, AdvancedExternalizer's will be removed in a future release. Please utilise ProtoStream annotations on Java objects instead by configuring a SerializationContextInitializer via addContextInitializer(SerializationContextInitializer), or specifying a custom marshaller for user types via marshaller(Marshaller).

Helper method that allows for quick registration of an AdvancedExternalizer implementation alongside its corresponding identifier. Remember that the identifier needs to a be positive number, including 0, and cannot clash with other identifiers in the system.

Parameters:

advancedExternalizer -

addAdvancedExternalizer

@Deprecated(forRemoval=true,
            since="10.0")
public <T> SerializationConfigurationBuilder addAdvancedExternalizer(AdvancedExternalizer<T>... advancedExternalizers)

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

since 10.0, AdvancedExternalizer's will be removed in a future release. Please utilise ProtoStream annotations on Java objects instead by configuring a SerializationContextInitializer via addContextInitializer(SerializationContextInitializer), or specifying a custom marshaller for user types via marshaller(Marshaller).

Helper method that allows for quick registration of AdvancedExternalizer implementations.

Parameters:

advancedExternalizers -

addContextInitializer

public SerializationConfigurationBuilder addContextInitializer(org.infinispan.protostream.SerializationContextInitializer sci)

addContextInitializers

public SerializationConfigurationBuilder addContextInitializers(org.infinispan.protostream.SerializationContextInitializer... scis)

addContextInitializers

public SerializationConfigurationBuilder addContextInitializers(List<org.infinispan.protostream.SerializationContextInitializer> scis)

allowList

public AllowListConfigurationBuilder allowList()

schemaCompatibilityValidation

public SerializationConfigurationBuilder schemaCompatibilityValidation(org.infinispan.protostream.config.Configuration.SchemaValidation schemaValidation)

whiteList

@Deprecated(forRemoval=true,
            since="12.0")
public WhiteListConfigurationBuilder whiteList()

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

since 12.0. Use allowList() instead. To be removed in 14.0.

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<SerializationConfiguration>

create

public SerializationConfiguration create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<SerializationConfiguration>

Returns:

read

public SerializationConfigurationBuilder read(SerializationConfiguration template,
 Combine combine)

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<SerializationConfiguration>

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()

Overrides:

toString in class Object

getGlobalConfig

protected GlobalConfigurationBuilder getGlobalConfig()

transport

public TransportConfigurationBuilder transport()

Description copied from interface: GlobalConfigurationChildBuilder

Transport-related (i.e. clustering) configuration

Specified by:

transport in interface GlobalConfigurationChildBuilder

metrics

public GlobalMetricsConfigurationBuilder metrics()

Description copied from interface: GlobalConfigurationChildBuilder

Global metrics configuration.

Specified by:

metrics in interface GlobalConfigurationChildBuilder

tracing

public GlobalTracingConfigurationBuilder tracing()

Description copied from interface: GlobalConfigurationChildBuilder

Global tracing configuration.

Specified by:

tracing in interface GlobalConfigurationChildBuilder

jmx

public GlobalJmxConfigurationBuilder jmx()

Description copied from interface: GlobalConfigurationChildBuilder

Global JMX configuration.

Specified by:

jmx in interface GlobalConfigurationChildBuilder

globalState

public GlobalStateConfigurationBuilder globalState()

Description copied from interface: GlobalConfigurationChildBuilder

Global state configuration

Specified by:

globalState in interface GlobalConfigurationChildBuilder

serialization

public SerializationConfigurationBuilder serialization()

Description copied from interface: GlobalConfigurationChildBuilder

Global serialization (i.e. marshalling) configuration

Specified by:

serialization in interface GlobalConfigurationChildBuilder

listenerThreadPool

public ThreadPoolConfigurationBuilder listenerThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the listener thread pool

Specified by:

listenerThreadPool in interface GlobalConfigurationChildBuilder

asyncThreadPool

public ThreadPoolConfigurationBuilder asyncThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the asynchronous operations thread pool

Specified by:

asyncThreadPool in interface GlobalConfigurationChildBuilder

expirationThreadPool

public ThreadPoolConfigurationBuilder expirationThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the expiration thread pool

Specified by:

expirationThreadPool in interface GlobalConfigurationChildBuilder

persistenceThreadPool

public ThreadPoolConfigurationBuilder persistenceThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the persistence thread pool

Specified by:

persistenceThreadPool in interface GlobalConfigurationChildBuilder

blockingThreadPool

public ThreadPoolConfigurationBuilder blockingThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the blocking thread pool

Specified by:

blockingThreadPool in interface GlobalConfigurationChildBuilder

nonBlockingThreadPool

public ThreadPoolConfigurationBuilder nonBlockingThreadPool()

Description copied from interface: GlobalConfigurationChildBuilder

Configuration for the non blocking thread pool

Specified by:

nonBlockingThreadPool in interface GlobalConfigurationChildBuilder

security

public GlobalSecurityConfigurationBuilder security()

Description copied from interface: GlobalConfigurationChildBuilder

Security-related configuration

Specified by:

security in interface GlobalConfigurationChildBuilder

shutdown

public ShutdownConfigurationBuilder shutdown()

Description copied from interface: GlobalConfigurationChildBuilder

Shutdown configuration

Specified by:

shutdown in interface GlobalConfigurationChildBuilder

site

public SiteConfigurationBuilder site()

Description copied from interface: GlobalConfigurationChildBuilder

Cross-site replication configuration

Specified by:

site in interface GlobalConfigurationChildBuilder

modules

public List<Builder<?>> modules()

Description copied from interface: GlobalConfigurationChildBuilder

Global modules configuration

Specified by:

modules in interface GlobalConfigurationChildBuilder

defaultCacheName

public GlobalConfigurationBuilder defaultCacheName(String defaultCacheName)

Description copied from interface: GlobalConfigurationChildBuilder

Sets the name of the cache that acts as the default cache and is returned by EmbeddedCacheManager.getCache(). Not

Specified by:

defaultCacheName in interface GlobalConfigurationChildBuilder

build

public GlobalConfiguration build()

Description copied from interface: GlobalConfigurationChildBuilder

Builds a GlobalConfiguration object using the settings applied to this builder

Specified by:

build in interface GlobalConfigurationChildBuilder