|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.tiles.factory.TilesContainerFactory
public class TilesContainerFactory
Factory provided for convenience. This factory creates a default implementation of the container, initializes, and puts it into service.
Field Summary | |
---|---|
static java.lang.String |
CONTAINER_FACTORY_INIT_PARAM
Initialization parameter that represents the container factory class name. |
static java.lang.String |
CONTAINER_FACTORY_MUTABLE_INIT_PARAM
Initialization parameter that indicates if the container factory is mutable. |
static java.lang.String |
CONTEXT_FACTORY_INIT_PARAM
Initialization parameter that represents the context factory class name. |
protected java.util.Map<java.lang.String,java.lang.String> |
defaultConfiguration
The default configuration to be used by the factory. |
static java.lang.String |
DEFINITIONS_FACTORY_INIT_PARAM
Initialization parameter that represents the definitions factory class name. |
static java.lang.String |
PREPARER_FACTORY_INIT_PARAM
Initialization parameter that represents the preparer factory class name. |
Constructor Summary | |
---|---|
TilesContainerFactory()
|
Method Summary | |
---|---|
TilesContainer |
createContainer(java.lang.Object context)
Creates a Tiles container. |
protected static java.lang.Object |
createFactory(java.util.Map<java.lang.String,java.lang.String> configuration,
java.lang.String initParameterName)
Creates a factory instance. |
MutableTilesContainer |
createMutableTilesContainer(java.lang.Object context)
Creates a mutable Tiles container. |
TilesContainer |
createTilesContainer(java.lang.Object context)
Creates an immutable Tiles container. |
static TilesContainerFactory |
getFactory(java.lang.Object context)
Retrieve a factory instance as configured through the specified context. |
static TilesContainerFactory |
getFactory(java.lang.Object context,
java.util.Map<java.lang.String,java.lang.String> defaults)
Retrieve a factory instance as configured through the specified context. |
protected static java.lang.String |
getInitParameter(java.lang.Object context,
java.lang.String parameterName)
Returns the value of an initialization parameter. |
protected static java.util.Map<java.lang.String,java.lang.String> |
getInitParameterMap(java.lang.Object context)
Returns a map containing parameters name-value entries. |
protected void |
initializeContainer(java.lang.Object context,
BasicTilesContainer container)
Initializes a container. |
protected static java.lang.String |
resolveFactoryName(java.util.Map<java.lang.String,java.lang.String> configuration,
java.lang.String parameterName)
Resolves a factory class name. |
void |
setDefaultConfiguration(java.util.Map<java.lang.String,java.lang.String> defaultConfiguration)
Sets the default configuration parameters. |
void |
setDefaultValue(java.lang.String key,
java.lang.String value)
Sets one default configuration parameter value. |
protected void |
storeContainerDependencies(java.lang.Object context,
java.util.Map<java.lang.String,java.lang.String> initParameters,
java.util.Map<java.lang.String,java.lang.String> configuration,
BasicTilesContainer container)
Stores container dependencies, that is called before TilesContainer.init(Map) . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String CONTAINER_FACTORY_INIT_PARAM
public static final java.lang.String CONTAINER_FACTORY_MUTABLE_INIT_PARAM
public static final java.lang.String CONTEXT_FACTORY_INIT_PARAM
public static final java.lang.String DEFINITIONS_FACTORY_INIT_PARAM
public static final java.lang.String PREPARER_FACTORY_INIT_PARAM
protected java.util.Map<java.lang.String,java.lang.String> defaultConfiguration
Constructor Detail |
---|
public TilesContainerFactory()
Method Detail |
---|
public static TilesContainerFactory getFactory(java.lang.Object context) throws TilesException
context
- the executing applications context.
Typically a ServletContext or PortletContext
TilesException
- if an error occurs creating the factory.public static TilesContainerFactory getFactory(java.lang.Object context, java.util.Map<java.lang.String,java.lang.String> defaults) throws TilesException
context
- the executing applications context. Typically a
ServletContext or PortletContextdefaults
- Default configuration parameters values, used if the
context object has not the corresponding parameters.
TilesException
- if an error occurs creating the factory.public TilesContainer createContainer(java.lang.Object context) throws TilesException
context
- The (application) context object.
TilesException
- If something goes wrong during instantiation.public void setDefaultConfiguration(java.util.Map<java.lang.String,java.lang.String> defaultConfiguration)
defaultConfiguration
- The default configuration parameters.public void setDefaultValue(java.lang.String key, java.lang.String value)
key
- The key of the configuration parameter.value
- The value of the configuration parameter.public TilesContainer createTilesContainer(java.lang.Object context) throws TilesException
context
- The (application) context object.
TilesException
- If something goes wrong during initialization.public MutableTilesContainer createMutableTilesContainer(java.lang.Object context) throws TilesException
context
- The (application) context object.
TilesException
- If something goes wrong during initialization.protected void initializeContainer(java.lang.Object context, BasicTilesContainer container) throws TilesException
context
- The (application) context object to use.container
- The container to be initialized.
TilesException
- If something goes wrong during initialization.protected void storeContainerDependencies(java.lang.Object context, java.util.Map<java.lang.String,java.lang.String> initParameters, java.util.Map<java.lang.String,java.lang.String> configuration, BasicTilesContainer container) throws TilesException
TilesContainer.init(Map)
.
context
- The (application) context object to use.initParameters
- The initialization parameters.configuration
- The merged configuration parameters (both defaults
and context ones).container
- The container to use.
TilesException
- If something goes wrong during initialization.protected static java.lang.Object createFactory(java.util.Map<java.lang.String,java.lang.String> configuration, java.lang.String initParameterName) throws TilesException
configuration
- The merged configuration parameters (both defaults
and context ones).initParameterName
- The initialization parameter name from which the
class name is got.
TilesException
- If something goes wrong during creation.protected static java.lang.String resolveFactoryName(java.util.Map<java.lang.String,java.lang.String> configuration, java.lang.String parameterName) throws TilesException
configuration
- The merged configuration parameters (both defaults
and context ones).parameterName
- The name of the initialization parameter to use.
TilesException
- If something goes wrong during resolution.protected static java.lang.String getInitParameter(java.lang.Object context, java.lang.String parameterName) throws TilesException
context
- The (application) context object to use.parameterName
- The parameter name to retrieve.
TilesException
- If the context has not been recognized.protected static java.util.Map<java.lang.String,java.lang.String> getInitParameterMap(java.lang.Object context) throws TilesException
context
- The (application) context object to use.
TilesException
- If the context object has not been recognized.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |