Class GlobalStateConfigurationBuilder

java.lang.Object

org.infinispan.configuration.global.AbstractGlobalConfigurationBuilder

org.infinispan.configuration.global.GlobalStateConfigurationBuilder

All Implemented Interfaces:

Builder<GlobalStateConfiguration>, GlobalConfigurationChildBuilder

public class GlobalStateConfigurationBuilder
extends AbstractGlobalConfigurationBuilder
implements Builder<GlobalStateConfiguration>

GlobalStateConfigurationBuilder. Configures filesystem paths where global state is stored.

Since:

8.1

Author:

Tristan Tarrant

Method Summary

Modifier and Type	Method	Description
AttributeSet	attributes()
GlobalStateConfigurationBuilder	configurationStorage(ConfigurationStorage storage)	Defines the ConfigurationStorage strategy to use.
GlobalStateConfigurationBuilder	configurationStorageSupplier(Supplier<? extends LocalConfigurationStorage> configurationStorageSupplier)	Defines the @LocalConfigurationStorage.
GlobalStateConfiguration	create()	Create the configuration bean
GlobalStateConfigurationBuilder	disable()
GlobalStateConfigurationBuilder	enable()
boolean	enabled()
GlobalStateConfigurationBuilder	enabled(boolean enabled)	Enables or disables the storage of global state.
GlobalStateConfigurationBuilder	persistentLocation(String location)	Defines the filesystem path where node-specific persistent data which needs to survive container restarts should be stored.
GlobalStateConfigurationBuilder	persistentLocation(String path, String relativeTo)
Builder<?>	read(GlobalStateConfiguration template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
GlobalStateConfigurationBuilder	sharedPersistentLocation(String location)	Defines the filesystem path where shared persistent state data which needs to survive container restarts should be stored.
GlobalStateConfigurationBuilder	sharedPersistentLocation(String path, String relativeTo)
GlobalStateConfigurationBuilder	temporaryLocation(String location)	Defines the filesystem path where temporary state should be stored.
GlobalStateConfigurationBuilder	temporaryLocation(String path, String relativeTo)
GlobalStateConfigurationBuilder	uncleanShutdownAction(UncleanShutdownAction action)	Defines the action taken when a dangling lock file is found in the persistent global state, signifying an unclean shutdown of the node (usually because of a crash or an external termination).
void	validate()	Validate the data in this builder before building the configuration bean

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, toString, 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<GlobalStateConfiguration>

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

uncleanShutdownAction

public GlobalStateConfigurationBuilder uncleanShutdownAction(UncleanShutdownAction action)

Defines the action taken when a dangling lock file is found in the persistent global state, signifying an unclean shutdown of the node (usually because of a crash or an external termination).

persistentLocation

public GlobalStateConfigurationBuilder persistentLocation(String location)

Defines the filesystem path where node-specific persistent data which needs to survive container restarts should be stored. This path will be used as the default storage location for file-based cache stores such as the default SingleFileStore as well as the consistent hash for all caches which enables graceful shutdown and restart. Because the data stored in the persistent location is specific to the node that owns it, 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.

persistentLocation

public GlobalStateConfigurationBuilder persistentLocation(String path,
 String relativeTo)

sharedPersistentLocation

public GlobalStateConfigurationBuilder sharedPersistentLocation(String location)

Defines the filesystem path where shared persistent state data which needs to survive container restarts should be stored. In particular this path will contain persistent dynamic configuration, as that managed by the OverlayLocalConfigurationStorage. This path MAY be safely shared among multiple instances. If not set, this will use the persistentLocation value. This value should be overridden to a more appropriate location.

sharedPersistentLocation

public GlobalStateConfigurationBuilder sharedPersistentLocation(String path,
 String relativeTo)

temporaryLocation

public GlobalStateConfigurationBuilder temporaryLocation(String location)

Defines the filesystem path where temporary state should be stored. Defaults to the value of the java.io.tmpdir system property.

temporaryLocation

public GlobalStateConfigurationBuilder temporaryLocation(String path,
 String relativeTo)

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

configurationStorageSupplier

public GlobalStateConfigurationBuilder configurationStorageSupplier(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,
 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<GlobalStateConfiguration>

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.