org.infinispan.config
Class InfinispanConfiguration

java.lang.Object
  org.infinispan.config.InfinispanConfiguration

All Implemented Interfaces:

XmlConfigurationParser

public class InfinispanConfiguration
extends Object
implements XmlConfigurationParser

InfinispanConfiguration encapsulates root component of Infinispan XML configuration

Note that class InfinispanConfiguration contains JAXB annotations. These annotations determine how XML configuration files are read into instances of configuration class hierarchy as well as they provide meta data for configuration file XML schema generation. Please modify these annotations and Java element types they annotate with utmost understanding and care.

Since:

4.0

Author:

Vladimir Blagojevic

Field Summary

static String	SCHEMA_SYSTEM_PROPERTY
static String	SCHEMA_URL_SYSTEM_PROPERTY
static String	SKIP_TOKEN_REPLACEMENT
static String	VALIDATING_SYSTEM_PROPERTY

Constructor Summary

InfinispanConfiguration()
Should never called.

Method Summary

void	accept(ConfigurationBeanVisitor v)
static InputStream	findSchemaInputStream()
static InfinispanConfiguration	newInfinispanConfiguration(InputStream config) Factory method to create an instance of Infinispan configuration.
static InfinispanConfiguration	newInfinispanConfiguration(InputStream config, InputStream schema) Factory method to create an instance of Infinispan configuration.
static InfinispanConfiguration	newInfinispanConfiguration(InputStream config, InputStream schema, ConfigurationBeanVisitor cbv) Factory method to create an instance of Infinispan configuration.
static InfinispanConfiguration	newInfinispanConfiguration(String configFileName) Factory method to create an instance of Infinispan configuration.
static InfinispanConfiguration	newInfinispanConfiguration(String configFileName, String schemaFileName) Factory method to create an instance of Infinispan configuration.
static InfinispanConfiguration	newInfinispanConfiguration(String configFileName, String schemaFileName, ConfigurationBeanVisitor cbv) Factory method to create an instance of Infinispan configuration.
Configuration	parseDefaultConfiguration() Parses the default template configuration.
GlobalConfiguration	parseGlobalConfiguration() GlobalConfiguration would also have a reference to the template default configuration, accessible via org.infinispan.config.GlobalConfiguration#getDefaultConfiguration() This is typically used to configure a DefaultCacheManager
Map<String,Configuration>	parseNamedConfigurations() Parses and retrieves configuration overrides for named caches.
static String	resolveSchemaPath()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VALIDATING_SYSTEM_PROPERTY

public static final String VALIDATING_SYSTEM_PROPERTY

See Also:

Constant Field Values

SKIP_TOKEN_REPLACEMENT

public static final String SKIP_TOKEN_REPLACEMENT

See Also:

Constant Field Values

SCHEMA_SYSTEM_PROPERTY

public static final String SCHEMA_SYSTEM_PROPERTY

See Also:

Constant Field Values

SCHEMA_URL_SYSTEM_PROPERTY

public static final String SCHEMA_URL_SYSTEM_PROPERTY

See Also:

Constant Field Values

Constructor Detail

InfinispanConfiguration

public InfinispanConfiguration()

Should never called. Construct InfinispanConfiguration with constructor other than no-arg constructor

Needed for reflection

Method Detail

newInfinispanConfiguration

public static InfinispanConfiguration newInfinispanConfiguration(String configFileName,
                                                                 String schemaFileName)
                                                          throws IOException

Factory method to create an instance of Infinispan configuration. If users want to verify configuration file correctness against Infinispan schema then appropriate schema file name should be provided as well.

Both configuration file and schema file are looked up in following order:

1. using current thread's context ClassLoader
2. if fails, the system ClassLoader
3. if fails, attempt is made to load it as a file from the disk

Parameters:

configFileName - configuration file name

schemaFileName - schema file name

Returns:

infinispan configuration

Throws:

IOException - if there are any issues creating InfinispanConfiguration object

newInfinispanConfiguration

public static InfinispanConfiguration newInfinispanConfiguration(String configFileName,
                                                                 String schemaFileName,
                                                                 ConfigurationBeanVisitor cbv)
                                                          throws IOException

Factory method to create an instance of Infinispan configuration. If users want to verify configuration file correctness against Infinispan schema then appropriate schema file name should be provided as well.

Both configuration file and schema file are looked up in following order:

1. using current thread's context ClassLoader
2. if fails, the system ClassLoader
3. if fails, attempt is made to load it as a file from the disk

Parameters:

configFileName - configuration file name

schemaFileName - schema file name

cbv - configuration bean visitor passed to constructed InfinispanConfiguration

Returns:

infinispan configuration

Throws:

IOException - if there are any issues creating InfinispanConfiguration object

newInfinispanConfiguration

public static InfinispanConfiguration newInfinispanConfiguration(String configFileName)
                                                          throws IOException

Factory method to create an instance of Infinispan configuration.

Configuration file is looked up in following order:

1. using current thread's context ClassLoader
2. if fails, the system ClassLoader
3. if fails, attempt is made to load it as a file from the disk

Parameters:

configFileName - configuration file name

Returns:

returns infinispan configuration

Throws:

IOException - if there are any issues creating InfinispanConfiguration object

newInfinispanConfiguration

public static InfinispanConfiguration newInfinispanConfiguration(InputStream config)
                                                          throws IOException

Factory method to create an instance of Infinispan configuration.

Parameters:

config - configuration input stream

Returns:

returns infinispan configuration

Throws:

IOException - if there are any issues creating InfinispanConfiguration object

newInfinispanConfiguration

public static InfinispanConfiguration newInfinispanConfiguration(InputStream config,
                                                                 InputStream schema)
                                                          throws IOException

Factory method to create an instance of Infinispan configuration. If users want to verify configuration file correctness against Infinispan schema then appropriate schema input stream should be provided as well.

Parameters:

config - configuration input stream

schema - schema inputstream

Returns:

infinispan configuration

Throws:

IOException - if there are any issues creating InfinispanConfiguration object

newInfinispanConfiguration

public static InfinispanConfiguration newInfinispanConfiguration(InputStream config,
                                                                 InputStream schema,
                                                                 ConfigurationBeanVisitor cbv)
                                                          throws IOException

Factory method to create an instance of Infinispan configuration. If users want to verify configuration file correctness against Infinispan schema then appropriate schema input stream should be provided as well.

Parameters:

config - configuration input stream

schema - schema inputstream

cbv - configuration bean visitor passed to constructed InfinispanConfiguration

Returns:

infinispan configuration

Throws:

IOException - if there are any issues creating InfinispanConfiguration object

findSchemaInputStream

public static InputStream findSchemaInputStream()

resolveSchemaPath

public static String resolveSchemaPath()

accept

public void accept(ConfigurationBeanVisitor v)

parseDefaultConfiguration

public Configuration parseDefaultConfiguration()
                                        throws ConfigurationException

Description copied from interface: XmlConfigurationParser

Parses the default template configuration.

Specified by:

parseDefaultConfiguration in interface XmlConfigurationParser

Returns:

a configuration instance representing the "default" block in the configuration file

Throws:

ConfigurationException - if there is a problem parsing the configuration XML

parseGlobalConfiguration

public GlobalConfiguration parseGlobalConfiguration()

Description copied from interface: XmlConfigurationParser

GlobalConfiguration would also have a reference to the template default configuration, accessible via org.infinispan.config.GlobalConfiguration#getDefaultConfiguration()

This is typically used to configure a DefaultCacheManager

Specified by:

parseGlobalConfiguration in interface XmlConfigurationParser

Returns:

a GlobalConfiguration as parsed from the configuration file.

parseNamedConfigurations

public Map<String,Configuration> parseNamedConfigurations()
                                                   throws ConfigurationException

Description copied from interface: XmlConfigurationParser

Parses and retrieves configuration overrides for named caches.

Specified by:

parseNamedConfigurations in interface XmlConfigurationParser

Returns:

a Map of Configuration overrides keyed on cache name

Throws:

ConfigurationException - if there is a problem parsing the configuration XML