org.apache.shindig.config

Interface ContainerConfig.Transaction

All Known Implementing Classes:

BasicContainerConfig.BasicTransaction, ExpressionContainerConfig.ExpressionTransaction

Enclosing interface:

ContainerConfig

public static interface ContainerConfig.Transaction

A transaction object allows to create, modify and remove one or more containers at a time.

Method Summary

Methods

Modifier and Type	Method and Description
ContainerConfig.Transaction	addContainer(Map<String,Object> container) Adds or modifies 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.
ContainerConfig.Transaction	removeContainer(String name) Removes a container configuration.

Method Detail

clearContainers

ContainerConfig.Transaction clearContainers()

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

Returns:

The transaction object, to allow chaining operations.

addContainer

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

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.

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

ContainerConfig.Transaction removeContainer(String name)

Removes a container configuration.

Parameters:

name - The name of the container to remove.

Returns:

The transaction object, to allow chaining operations.

commit

void commit()
            throws ContainerConfigException

Performs all the transaction operations on the container configuration.

Throws:

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