SerializationConfigurationBuilder (Infinispan JavaDoc All 9.0.3.Final API)

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

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`<T> SerializationConfigurationBuilder`	`addAdvancedExternalizer(AdvancedExternalizer<T>... advancedExternalizers)` Helper method that allows for quick registration of `AdvancedExternalizer` implementations.
`<T> SerializationConfigurationBuilder`	`addAdvancedExternalizer(AdvancedExternalizer<T> advancedExternalizer)` Helper method that allows for quick registration of an `AdvancedExternalizer` implementation alongside its corresponding identifier.
`<T> SerializationConfigurationBuilder`	`addAdvancedExternalizer(int id, AdvancedExternalizer<T> advancedExternalizer)` Helper method that allows for quick registration of an `AdvancedExternalizer` implementation alongside its corresponding identifier.
`ThreadPoolConfigurationBuilder`	`asyncThreadPool()` Configuration for the asynchronous operations thread pool
`GlobalConfiguration`	`build()` Builds a `GlobalConfiguration` object using the settings applied to this builder
`SerializationConfigurationBuilder`	`classResolver(ClassResolver classResolver)` Class resolver to use when unmarshalling objects.
`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 `CacheContainer.getCache()`.
`ThreadPoolConfigurationBuilder`	`evictionThreadPool()` Deprecated.
`ThreadPoolConfigurationBuilder`	`expirationThreadPool()` Configuration for the expiration thread pool
`protected GlobalConfigurationBuilder`	`getGlobalConfig()`
`Marshaller`	`getMarshaller()`
`GlobalJmxStatisticsConfigurationBuilder`	`globalJmxStatistics()` Global JMX configuration
`GlobalStateConfigurationBuilder`	`globalState()` Global state configuration
`ThreadPoolConfigurationBuilder`	`listenerThreadPool()` Configuration for the listener thread pool
`SerializationConfigurationBuilder`	`marshaller(Marshaller marshaller)` Set the marshaller instance that will marshall and unmarshall cache entries.
`List<Builder<?>>`	`modules()` Global modules configuration
`ThreadPoolConfigurationBuilder`	`persistenceThreadPool()` Configuration for the persistence thread pool
`SerializationConfigurationBuilder`	`read(SerializationConfiguration template)` Reads the configuration from an already created configuration bean into this builder.
`ThreadPoolConfigurationBuilder`	`replicationQueueThreadPool()`
`GlobalSecurityConfigurationBuilder`	`security()` Security-related configuration
`SerializationConfigurationBuilder`	`serialization()` Global serialization (i.e.
`ShutdownConfigurationBuilder`	`shutdown()` Shutdown configuration
`SiteConfigurationBuilder`	`site()` Cross-site replication configuration
`ThreadPoolConfigurationBuilder`	`stateTransferThreadPool()` Configuration for the state-transfer thread pool
`String`	`toString()`
`TransportConfigurationBuilder`	`transport()` Transport-related (i.e.
`void`	`validate()` Validate the data in this builder before building the configuration bean
`SerializationConfigurationBuilder`	`version(short marshallVersion)` Largest allowable version to use when marshalling internal state.
`SerializationConfigurationBuilder`	`version(String marshallVersion)` Largest allowable version to use when marshalling internal state.

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

- Method Detail
  - marshaller
```
public SerializationConfigurationBuilder marshaller(Marshaller marshaller)
```
    Set the marshaller instance that will marshall and unmarshall cache entries.
    
    Parameters:
    
    marshaller -
  - getMarshaller
```
public Marshaller getMarshaller()
```
  - version
```
public SerializationConfigurationBuilder version(short marshallVersion)
```
    Largest allowable version to use when marshalling internal state. Set this to the lowest version cache instance in your cluster to ensure compatibility of communications. However, setting this too low will mean you lose out on the benefit of improvements in newer versions of the marshaller.
    
    Parameters:
    
    marshallVersion -
  - version
```
public SerializationConfigurationBuilder version(String marshallVersion)
```
    Largest allowable version to use when marshalling internal state. Set this to the lowest version cache instance in your cluster to ensure compatibility of communications. However, setting this too low will mean you lose out on the benefit of improvements in newer versions of the marshaller.
    
    Parameters:
    
    marshallVersion -
  - addAdvancedExternalizer
```
public <T> SerializationConfigurationBuilder addAdvancedExternalizer(int id,
                                                                     AdvancedExternalizer<T> advancedExternalizer)
```
    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
```
public <T> SerializationConfigurationBuilder addAdvancedExternalizer(AdvancedExternalizer<T> advancedExternalizer)
```
    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
```
public <T> SerializationConfigurationBuilder addAdvancedExternalizer(AdvancedExternalizer<T>... advancedExternalizers)
```
    Helper method that allows for quick registration of AdvancedExternalizer implementations.
    
    Parameters:
    
    advancedExternalizers -
  - classResolver
```
public SerializationConfigurationBuilder classResolver(ClassResolver classResolver)
```
    Class resolver to use when unmarshalling objects.
    
    Parameters:
    
    classResolver -
  - 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)
```
    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.
  - 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
  - globalJmxStatistics
```
public GlobalJmxStatisticsConfigurationBuilder globalJmxStatistics()
```
    Description copied from interface: GlobalConfigurationChildBuilder
    
    Global JMX configuration
    
    Specified by:
    
    globalJmxStatistics 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
  - replicationQueueThreadPool
```
public ThreadPoolConfigurationBuilder replicationQueueThreadPool()
```
    Specified by:
    
    replicationQueueThreadPool in interface GlobalConfigurationChildBuilder
  - evictionThreadPool
```
@Deprecated
public ThreadPoolConfigurationBuilder evictionThreadPool()
```
    Deprecated.
    
    Description copied from interface: GlobalConfigurationChildBuilder
    
    Please use GlobalConfigurationChildBuilder.expirationThreadPool()
    
    Specified by:
    
    evictionThreadPool 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
  - stateTransferThreadPool
```
public ThreadPoolConfigurationBuilder stateTransferThreadPool()
```
    Description copied from interface: GlobalConfigurationChildBuilder
    
    Configuration for the state-transfer thread pool
    
    Specified by:
    
    stateTransferThreadPool 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 CacheContainer.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

Class SerializationConfigurationBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

marshaller

getMarshaller

version

version

addAdvancedExternalizer

addAdvancedExternalizer

addAdvancedExternalizer

classResolver

validate

create

read

toString

getGlobalConfig

transport

globalJmxStatistics

globalState

serialization

listenerThreadPool

asyncThreadPool

replicationQueueThreadPool

evictionThreadPool

expirationThreadPool

persistenceThreadPool

stateTransferThreadPool

security

shutdown

site

modules

defaultCacheName

build