Class Configuration

java.lang.Object

org.infinispan.commons.configuration.attributes.ConfigurationElement<Configuration>

org.infinispan.configuration.cache.Configuration

All Implemented Interfaces:

Matchable<Configuration>, Updatable<Configuration>, BasicConfiguration

public class Configuration
extends ConfigurationElement<Configuration>
implements BasicConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
static final AttributeDefinition<Set<String>>	ALIASES
static final AttributeDefinition<String>	CONFIGURATION
static final AttributeDefinition<Boolean>	SIMPLE_CACHE

Fields inherited from class ConfigurationElement

attributes, CHILDLESS, children, element, repeated, sinceMajor, sinceMinor

Method Summary

Modifier and Type	Method	Description
Collection<String>	aliases()
static AttributeSet	attributeDefinitionSet()
ClusteringConfiguration	clustering()
EncodingConfiguration	encoding()
boolean	equals(Object o)
ExpirationConfiguration	expiration()
int	hashCode()
IndexingConfiguration	indexing()
InvocationBatchingConfiguration	invocationBatching()	Deprecated. Since 17.0, use TransactionConfiguration.invocationBatching() via transaction().
boolean	isTemplate()
LockingConfiguration	locking()
boolean	matches(Configuration other)
MemoryConfiguration	memory()
<T> T	module(Class<T> moduleClass)
Map<Class<?>,?>	modules()
PersistenceConfiguration	persistence()
QueryConfiguration	query()
SecurityConfiguration	security()
boolean	simpleCache()
SitesConfiguration	sites()
StatisticsConfiguration	statistics()
String	toString()
String	toStringConfiguration(String name, MediaType mediaType, boolean clearTextSecrets)	Converts this configuration to a string representation.
String	toStringConfiguration(String name, MediaType mediaType, boolean clearTextSecrets, ConfigurationSchemaVersion target)	Serializes this configuration as XML, omitting any element or attribute whose since is newer than target, so the emitted document stays parseable by an older cluster member's parser.
TracingConfiguration	tracing()
TransactionConfiguration	transaction()
UnsafeConfiguration	unsafe()

Methods inherited from class ConfigurationElement

attributes, child, children, children, collectMutableAttributes, elementName, extractAttributes, findAttribute, isModified, isSince, list, matches, matches, update, update, update, validateUpdate, validateUpdate, validateUpdate, write

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface BasicConfiguration

toStringConfiguration

Field Details

CONFIGURATION

public static final AttributeDefinition<String> CONFIGURATION

SIMPLE_CACHE

public static final AttributeDefinition<Boolean> SIMPLE_CACHE

ALIASES

public static final AttributeDefinition<Set<String>> ALIASES

Method Details

attributeDefinitionSet

public static AttributeSet attributeDefinitionSet()

aliases

public Collection<String> aliases()

simpleCache

public boolean simpleCache()

clustering

public ClusteringConfiguration clustering()

encoding

public EncodingConfiguration encoding()

expiration

public ExpirationConfiguration expiration()

query

public QueryConfiguration query()

indexing

public IndexingConfiguration indexing()

tracing

public TracingConfiguration tracing()

invocationBatching

@Deprecated(since="17.0")
public InvocationBatchingConfiguration invocationBatching()

Deprecated.

Since 17.0, use TransactionConfiguration.invocationBatching() via transaction().

statistics

public StatisticsConfiguration statistics()

persistence

public PersistenceConfiguration persistence()

locking

public LockingConfiguration locking()

memory

public MemoryConfiguration memory()

module

public <T> T module(Class<T> moduleClass)

modules

public Map<Class<?>,?> modules()

transaction

public TransactionConfiguration transaction()

unsafe

public UnsafeConfiguration unsafe()

security

public SecurityConfiguration security()

sites

public SitesConfiguration sites()

isTemplate

public boolean isTemplate()

toString

public String toString()

Overrides:

toString in class ConfigurationElement<Configuration>

equals

public boolean equals(Object o)

Overrides:

equals in class ConfigurationElement<Configuration>

hashCode

public int hashCode()

Overrides:

hashCode in class ConfigurationElement<Configuration>

matches

public boolean matches(Configuration other)

Specified by:

matches in interface Matchable<Configuration>

Overrides:

matches in class ConfigurationElement<Configuration>

toStringConfiguration

public String toStringConfiguration(String name,
 MediaType mediaType,
 boolean clearTextSecrets)

Description copied from interface: BasicConfiguration

Converts this configuration to a string representation.

Specified by:

toStringConfiguration in interface BasicConfiguration

Parameters:

name - The name of the configuration in the generated string.

mediaType - The type of string to generate. Can be one of XML, JSON or YAML.

clearTextSecrets - Whether secrets (e.g. passwords) should be included in clear text or masked.

Returns:

a String containing the representation of an Infinispan configuration using the Infinispan schema in one of the supported formats (XML, JSON, YAML).

toStringConfiguration

public String toStringConfiguration(String name,
 MediaType mediaType,
 boolean clearTextSecrets,
 ConfigurationSchemaVersion target)

Description copied from interface: BasicConfiguration

Serializes this configuration as XML, omitting any element or attribute whose since is newer than target, so the emitted document stays parseable by an older cluster member's parser.

Specified by:

toStringConfiguration in interface BasicConfiguration

Parameters:

name - the name under which the cache configuration is emitted

mediaType - The type of string to generate. Can be one of XML, JSON or YAML.

clearTextSecrets - Whether secrets (e.g. passwords) should be included in clear text or masked.

target - the schema version the emitted document must stay compatible with, null includes all.

Returns:

the serialized configuration, with newer members omitted