org.apache.shindig.config

Class JsonContainerConfigLoader

java.lang.Object

org.apache.shindig.config.JsonContainerConfigLoader

public class JsonContainerConfigLoader
extends Object

A class to build container configurations from JSON notation. See config/container.js for an example configuration. We use a cascading model, so you only have to specify attributes in your config that you actually want to change. String values may use expressions. The variable context defaults to the 'current' container, but parent values may be accessed through the special "parent" property.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONTEXT_ROOT
static char	FILE_SEPARATOR
static String	SERVER_HOST
static String	SERVER_PORT

Method Summary

Methods

Modifier and Type	Method and Description
static ContainerConfig.Transaction	addToTransactionFromFile(String containers, String host, String port, String contextRoot, ContainerConfig.Transaction transaction) Appends the contents of one or more files or resources to an transaction.
static ContainerConfig.Transaction	getTransactionFromFile(String containers, String host, String port, String contextRoot, ContainerConfig containerConfig) Creates a transaction to append the contents of one or more files or resources to an existing configuration.
static Map<String,Object>	parseJsonContainer(JSONObject json) Parses a container in JSON notation.
static Map<String,Object>	parseJsonContainer(String json) Parses a container in JSON notation.

Methods inherited from class java.lang.Object

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

Field Detail

FILE_SEPARATOR

public static final char FILE_SEPARATOR

See Also:

Constant Field Values

SERVER_PORT

public static final String SERVER_PORT

See Also:

Constant Field Values

SERVER_HOST

public static final String SERVER_HOST

See Also:

Constant Field Values

CONTEXT_ROOT

public static final String CONTEXT_ROOT

See Also:

Constant Field Values

Method Detail

getTransactionFromFile

public static ContainerConfig.Transaction getTransactionFromFile(String containers,
                                                 String host,
                                                 String port,
                                                 String contextRoot,
                                                 ContainerConfig containerConfig)
                                                          throws ContainerConfigException

Creates a transaction to append the contents of one or more files or resources to an existing configuration.

Parameters:

containers - The comma-separated list of files or resources to load the container configurations from.

host - The hostname where Shindig is running.

port - The port number where Shindig is receiving requests.

contextRoot - contextRoot where Shindig module is deployed

containerConfig - The container configuration to add the contents of the file to.

Returns:

A transaction to add the new containers to the configuration.

Throws:

ContainerConfigException - If there was a problem reading the files.

addToTransactionFromFile

public static ContainerConfig.Transaction addToTransactionFromFile(String containers,
                                                   String host,
                                                   String port,
                                                   String contextRoot,
                                                   ContainerConfig.Transaction transaction)
                                                            throws ContainerConfigException

Appends the contents of one or more files or resources to an transaction.

Parameters:

containers - The comma-separated list of files or resources to load the container configurations from.

host - The hostname where Shindig is running.

port - The port number where Shindig is receiving requests.

transaction - The transaction to add the contents of the file to.

Returns:

The transaction, to allow chaining.

Throws:

ContainerConfigException - If there was a problem reading the files.

parseJsonContainer

public static Map<String,Object> parseJsonContainer(JSONObject json)

Parses a container in JSON notation.

Parameters:

json - The container configuration in JSON notation.

Returns:

A parsed container configuration.

parseJsonContainer

public static Map<String,Object> parseJsonContainer(String json)
                                             throws JSONException

Parses a container in JSON notation.

Parameters:

json - The container configuration in JSON notation.

Returns:

A parsed container configuration.

Throws:

JSONException - If there was a problem parsing the container.