org.apache.shindig.config

Interface ContainerConfig

All Known Implementing Classes:

BasicContainerConfig, ExpressionContainerConfig, JsonContainerConfig

public interface ContainerConfig

Represents a container configuration. Container configurations are used to support multiple, independent configurations in the same server instance. Global configuration values are handled via traditional mechanisms such as properties files or command-line flags bound through Guice's @Named annotation. This interface is implemented by two classes: - BasicContainerConfig provides configuration inheritance; - ExpressionContainerConfig extends BasicContainerConfig and also provides expression evaluation in string values and properties. Container configurations are stored by default in JSON format, for easy sharing with the code found in the PHP implementation of Shindig, and for easy readability. They can be loaded with the methods in JsonContainerConfigLoader.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ContainerConfig.ConfigObserver Interface for objects that get notified when container configurations are changed.
static interface	ContainerConfig.Transaction A transaction object allows to create, modify and remove one or more containers at a time.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTAINER_KEY
static String	DEFAULT_CONTAINER
static String	PARENT_KEY

Method Summary

Methods

Modifier and Type	Method and Description
void	addConfigObserver(ContainerConfig.ConfigObserver observer, boolean notifyNow) Adds an observer that will be notified when the configuration changes.
boolean	getBool(String container, String name)
Collection<String>	getContainers()
int	getInt(String container, String name)
<T> List<T>	getList(String container, String name)
<T> Map<String,T>	getMap(String container, String name)
Map<String,Object>	getProperties(String container) Fetch all properties for the given container configuration.
Object	getProperty(String container, String name)
String	getString(String container, String name)
ContainerConfig.Transaction	newTransaction() Creates a new transaction to create, modify or remove containers.

Field Detail

PARENT_KEY

static final String PARENT_KEY

See Also:

Constant Field Values

CONTAINER_KEY

static final String CONTAINER_KEY

See Also:

Constant Field Values

DEFAULT_CONTAINER

static final String DEFAULT_CONTAINER

See Also:

Constant Field Values

Method Detail

getContainers

Collection<String> getContainers()

Returns:

The set of all containers that are currently registered.

getProperties

Map<String,Object> getProperties(String container)

Fetch all properties for the given container configuration.

getProperty

Object getProperty(String container,
                 String name)

Returns:

The configuration property stored under the given name for the given container.

getString

String getString(String container,
               String name)

Returns:

The configuration property stored under the given name for the given container, or null if it is not defined or not a string.

getInt

int getInt(String container,
         String name)

Returns:

The configuration property stored under the given name for the given container, or 0 if it is not defined or not a number.

getBool

boolean getBool(String container,
              String name)

Returns:

The configuration property stored under the given name for the given container, or false if it is not defined or not a boolean.

getList

<T> List<T> getList(String container,
                  String name)

Returns:

The configuration property stored under the given name for the given container, or an empty list if it is not defined or not a list.

getMap

<T> Map<String,T> getMap(String container,
                       String name)

Returns:

The configuration property stored under the given name for the given container, or an empty map if it is not defined or not a map.

newTransaction

ContainerConfig.Transaction newTransaction()

Creates a new transaction to create, modify or remove containers.

Returns:

The new transaction object.

addConfigObserver

void addConfigObserver(ContainerConfig.ConfigObserver observer,
                     boolean notifyNow)

Adds an observer that will be notified when the configuration changes.

Parameters:

observer - The observer to be notified.

notifyNow - If true, the observer will receive an immediate notification for the current configuration.