org.apache.shindig.config

Class BasicContainerConfig.BasicTransaction

java.lang.Object

org.apache.shindig.config.BasicContainerConfig.BasicTransaction

All Implemented Interfaces:

ContainerConfig.Transaction

Direct Known Subclasses:

ExpressionContainerConfig.ExpressionTransaction

Enclosing class:

BasicContainerConfig

protected class BasicContainerConfig.BasicTransaction
extends Object
implements ContainerConfig.Transaction

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	clear
protected Set<String>	removeContainers
protected Map<String,Map<String,Object>>	setContainers
protected ContainerConfigException	throwException

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BasicContainerConfig.BasicTransaction()

Method Summary

Methods

Modifier and Type	Method and Description
ContainerConfig.Transaction	addContainer(Map<String,Object> container) Adds or modifies a container configuration.
protected void	changeContainersInConfig(BasicContainerConfig newConfig, Map<String,Map<String,Object>> setContainers, Set<String> removeContainers) Applies the requested changes in a container configuration.
ContainerConfig.Transaction	clearContainers() Clears the container configuration before performing the other operations in the transaction.
void	commit() Performs all the transaction operations on the container configuration.
protected Map<String,Map<String,Object>>	deepCopyConfig(Map<String,Map<String,Object>> config) Returns a deep copy of a configuration object.
protected BasicContainerConfig	getTemporaryConfig(boolean copyValues) Creates a temporary ContainerConfig object that optionally contains a copy of the current configuration.
protected Map<String,Object>	mergeParents(String name, Map<String,Map<String,Object>> config) Recursively merge values from parent containers in the prototype chain.
ContainerConfig.Transaction	removeContainer(String name) Removes a container configuration.
protected void	setNewConfig(BasicContainerConfig newConfig) Replaces the old configuration with the new configuration.

Methods inherited from class java.lang.Object

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

Field Detail

clear

protected boolean clear

setContainers

protected Map<String,Map<String,Object>> setContainers

removeContainers

protected Set<String> removeContainers

throwException

protected ContainerConfigException throwException

Constructor Detail

BasicContainerConfig.BasicTransaction

protected BasicContainerConfig.BasicTransaction()

Method Detail

clearContainers

public ContainerConfig.Transaction clearContainers()

Description copied from interface: ContainerConfig.Transaction

Clears the container configuration before performing the other operations in the transaction.

Specified by:

clearContainers in interface ContainerConfig.Transaction

Returns:

The transaction object, to allow chaining operations.

addContainer

public ContainerConfig.Transaction addContainer(Map<String,Object> container)

Description copied from interface: ContainerConfig.Transaction

Adds or modifies a container configuration. A container's names are specified in the gadgets.container property. If it is an array, a copy of the container will be created for each name in that property.

Specified by:

addContainer in interface ContainerConfig.Transaction

Parameters:

container - The container's new configuration, as a map from property name to property contents.

Returns:

The transaction object, to allow chaining operations.

removeContainer

public ContainerConfig.Transaction removeContainer(String name)

Description copied from interface: ContainerConfig.Transaction

Removes a container configuration.

Specified by:

removeContainer in interface ContainerConfig.Transaction

Parameters:

name - The name of the container to remove.

Returns:

The transaction object, to allow chaining operations.

commit

public void commit()
            throws ContainerConfigException

Description copied from interface: ContainerConfig.Transaction

Performs all the transaction operations on the container configuration.

Specified by:

commit in interface ContainerConfig.Transaction

Throws:

ContainerConfigException - If there was a problem applying the new configuration. If this exception is thrown, the existing configuration will not be modified.

getTemporaryConfig

protected BasicContainerConfig getTemporaryConfig(boolean copyValues)

Creates a temporary ContainerConfig object that optionally contains a copy of the current configuration. If you subclass BasicContainerConfig and you change its internals, you must generally override this method to generate an object of the same type as your subclass, and to fill its contents correctly.

Parameters:

copyValues - Whether the current configuration should be copied.

Returns:

A new ContainerConfig object of the appropriate type.

changeContainersInConfig

protected void changeContainersInConfig(BasicContainerConfig newConfig,
                            Map<String,Map<String,Object>> setContainers,
                            Set<String> removeContainers)
                                 throws ContainerConfigException

Applies the requested changes in a container configuration.

Parameters:

newConfig - The container configuration object to modify.

setContainers - A map from container name to container to add/modify.

removeContainers - A set of names of containers to remove.

Throws:

ContainerConfigException - If there was a problem setting the new configuration.

setNewConfig

protected void setNewConfig(BasicContainerConfig newConfig)

Replaces the old configuration with the new configuration.

Parameters:

newConfig - The map that contains the new configuration.

mergeParents

protected Map<String,Object> mergeParents(String name,
                              Map<String,Map<String,Object>> config)
                                   throws ContainerConfigException

Recursively merge values from parent containers in the prototype chain. For example, for the following two containers: { 'gadgets.container': ['default'], 'base': '/gadgets/foo', 'user': 'peter', 'map': { 'latitude': 42, 'longitude': -8 }, 'data': [ 'foo', 'bar' ] } { 'gadgets.container': ['new'], 'user': 'anne', 'colour': 'green', 'map': { 'longitude': 130 }, 'data': null } It would result in a merged "new" container that looks like this: { 'gadgets.container': ['new'], 'base': '/gadgets/foo', 'user': 'anne', 'colour': 'green', 'map': { 'latitude': 42, 'longitude': 130 }, 'data': null }

Returns:

The container merged with all parents.

Throws:

ContainerConfigException - If there is an invalid parent parameter in the prototype chain.

deepCopyConfig

protected Map<String,Map<String,Object>> deepCopyConfig(Map<String,Map<String,Object>> config)

Returns a deep copy of a configuration object.

Parameters:

config - The configuration object to copy.

Returns:

A copy of the configuration object.