Class SerializationConfigurationBuilder

java.lang.Object

org.infinispan.configuration.global.AbstractGlobalConfigurationBuilder

org.infinispan.configuration.global.SerializationConfigurationBuilder

All Implemented Interfaces:

Builder<SerializationConfiguration>, GlobalConfigurationChildBuilder

public class SerializationConfigurationBuilder
extends AbstractGlobalConfigurationBuilder
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()
AttributeSet	attributes()
SerializationConfiguration	create()	Create the configuration bean
Marshaller	getMarshaller()
SerializationConfigurationBuilder	marshaller(Marshaller marshaller)	Set the marshaller instance that will marshall and unmarshall cache entries.
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)
String	toString()
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 org.infinispan.configuration.global.AbstractGlobalConfigurationBuilder

addModule, asyncThreadPool, blockingThreadPool, build, clearModules, defaultCacheName, expirationThreadPool, getGlobalConfig, globalState, jmx, listenerThreadPool, metrics, module, modules, nonBlockingThreadPool, persistenceThreadPool, security, serialization, shutdown, site, tracing, transport

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