GlobalStateConfigurationBuilder

java.lang.Object
- org.infinispan.configuration.global.GlobalStateConfigurationBuilder

All Implemented Interfaces:

Builder<GlobalStateConfiguration>, GlobalConfigurationChildBuilder
```
public class GlobalStateConfigurationBuilder
extends java.lang.Object
implements Builder<GlobalStateConfiguration>
```
GlobalStateConfigurationBuilder. Configures filesystem paths where global state is stored.

Since:

8.1

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`ThreadPoolConfigurationBuilder`	`asyncThreadPool()` Configuration for the asynchronous operations thread pool
`GlobalConfiguration`	`build()` Builds a `GlobalConfiguration` object using the settings applied to this builder
`GlobalStateConfigurationBuilder`	`configurationStorage(ConfigurationStorage storage)` Defines the `ConfigurationStorage` strategy to use.
`GlobalStateConfigurationBuilder`	`configurationStorageSupplier(java.util.function.Supplier<? extends LocalConfigurationStorage> configurationStorageSupplier)` Defines the @`LocalConfigurationStorage`.
`GlobalStateConfiguration`	`create()` Create the configuration bean
`GlobalConfigurationBuilder`	`defaultCacheName(java.lang.String defaultCacheName)` Sets the name of the cache that acts as the default cache and is returned by `CacheContainer.getCache()`.
`GlobalStateConfigurationBuilder`	`disable()`
`GlobalStateConfigurationBuilder`	`enable()`
`boolean`	`enabled()`
`GlobalStateConfigurationBuilder`	`enabled(boolean enabled)` Enables or disables the storage of global state.
`ThreadPoolConfigurationBuilder`	`evictionThreadPool()` Deprecated.
`ThreadPoolConfigurationBuilder`	`expirationThreadPool()` Configuration for the expiration thread pool
`protected GlobalConfigurationBuilder`	`getGlobalConfig()`
`GlobalJmxStatisticsConfigurationBuilder`	`globalJmxStatistics()` Global JMX configuration
`GlobalStateConfigurationBuilder`	`globalState()` Global state configuration
`ThreadPoolConfigurationBuilder`	`listenerThreadPool()` Configuration for the listener thread pool
`java.util.List<Builder<?>>`	`modules()` Global modules configuration
`ThreadPoolConfigurationBuilder`	`persistenceThreadPool()` Configuration for the persistence thread pool
`GlobalStateConfigurationBuilder`	`persistentLocation(java.lang.String location)` Defines the filesystem path where persistent state data which needs to survive container restarts should be stored.
`Builder<?>`	`read(GlobalStateConfiguration 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.
`GlobalStateConfigurationBuilder`	`sharedPersistentLocation(java.lang.String location)` Defines the filesystem path where shared persistent state data which needs to survive container restarts should be stored.
`ShutdownConfigurationBuilder`	`shutdown()` Shutdown configuration
`SiteConfigurationBuilder`	`site()` Cross-site replication configuration
`ThreadPoolConfigurationBuilder`	`stateTransferThreadPool()` Configuration for the state-transfer thread pool
`GlobalStateConfigurationBuilder`	`temporaryLocation(java.lang.String location)` Defines the filesystem path where temporary state should be stored.
`TransportConfigurationBuilder`	`transport()` Transport-related (i.e.
`void`	`validate()` Validate the data in this builder before building the configuration bean

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

- Method Detail
  - enable
```
public GlobalStateConfigurationBuilder enable()
```
  - disable
```
public GlobalStateConfigurationBuilder disable()
```
  - enabled
```
public GlobalStateConfigurationBuilder enabled(boolean enabled)
```
    Enables or disables the storage of global state.
  - enabled
```
public boolean enabled()
```
  - persistentLocation
```
public GlobalStateConfigurationBuilder persistentLocation(java.lang.String location)
```
    Defines the filesystem path where persistent state data which needs to survive container restarts should be stored. The data stored at this location is required for graceful shutdown and restore. This path must NOT be shared among multiple instances. Defaults to the user.dir system property which usually is where the application was started. This value should be overridden to a more appropriate location.
  - sharedPersistentLocation
```
public GlobalStateConfigurationBuilder sharedPersistentLocation(java.lang.String location)
```
    Defines the filesystem path where shared persistent state data which needs to survive container restarts should be stored. This path can be safely shared among multiple instances. Defaults to the user.dir system property which usually is where the application was started. This value should be overridden to a more appropriate location.
  - temporaryLocation
```
public GlobalStateConfigurationBuilder temporaryLocation(java.lang.String location)
```
    Defines the filesystem path where temporary state should be stored. Defaults to the value of the java.io.tmpdir system property.
  - configurationStorage
```
public GlobalStateConfigurationBuilder configurationStorage(ConfigurationStorage storage)
```
    Defines the ConfigurationStorage strategy to use. If using ConfigurationStorage.CUSTOM, then the actual implementation must be passed by invoking #localConfigurationManager(LocalConfigurationStorage)
  - configurationStorageSupplier
```
public GlobalStateConfigurationBuilder configurationStorageSupplier(java.util.function.Supplier<? extends LocalConfigurationStorage> configurationStorageSupplier)
```
    Defines the @LocalConfigurationStorage. Defaults to @VolatileLocalConfigurationStorage
  - 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<GlobalStateConfiguration>
  - create
```
public GlobalStateConfiguration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Specified by:
    
    create in interface Builder<GlobalStateConfiguration>
    
    Returns:
  - read
```
public Builder<?> read(GlobalStateConfiguration 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<GlobalStateConfiguration>
    
    Parameters:
    
    template - the configuration from which to "clone" this config if needed.
  - 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 java.util.List<Builder<?>> modules()
```
    Description copied from interface: GlobalConfigurationChildBuilder
    
    Global modules configuration
    
    Specified by:
    
    modules in interface GlobalConfigurationChildBuilder
  - defaultCacheName
```
public GlobalConfigurationBuilder defaultCacheName(java.lang.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 GlobalStateConfigurationBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

enable

disable

enabled

enabled

persistentLocation

sharedPersistentLocation

temporaryLocation

configurationStorage

configurationStorageSupplier

validate

create

read

getGlobalConfig

transport

globalJmxStatistics

globalState

serialization

listenerThreadPool

asyncThreadPool

replicationQueueThreadPool

evictionThreadPool

expirationThreadPool

persistenceThreadPool

stateTransferThreadPool

security

shutdown

site

modules

defaultCacheName

build