/*
* $Id: KeyedDefinitionsFactoryTilesContainerFactory.java 722062 2008-12-01 13:09:09Z apetrelli $
*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.tiles.factory;
import java.util.HashMap;
import java.util.Map;
import org.apache.tiles.TilesApplicationContext;
import org.apache.tiles.TilesContainer;
import org.apache.tiles.awareness.TilesApplicationContextAware;
import org.apache.tiles.context.TilesRequestContextFactory;
import org.apache.tiles.definition.DefinitionsFactory;
import org.apache.tiles.evaluator.AttributeEvaluator;
import org.apache.tiles.impl.BasicTilesContainer;
import org.apache.tiles.impl.KeyedDefinitionsFactoryTilesContainer;
import org.apache.tiles.impl.KeyedDefinitionsFactoryTilesContainer.KeyExtractor;
import org.apache.tiles.impl.mgmt.CachingKeyedDefinitionsFactoryTilesContainer;
import org.apache.tiles.mgmt.MutableTilesContainer;
import org.apache.tiles.reflect.ClassUtil;
import org.apache.tiles.renderer.RendererFactory;
/**
* Factory that creates instances of container that will extend the
* {@link KeyedDefinitionsFactoryTilesContainer} class.
*
* @version $Rev: 722062 $ $Date: 2008-12-01 14:09:09 +0100 (lun, 01 dic 2008) $
*/
public class KeyedDefinitionsFactoryTilesContainerFactory extends
TilesContainerFactory {
/**
* The name of the initialization parameter that will contain a
* comma-separated list of keys to use.
*/
public static final String CONTAINER_KEYS_INIT_PARAM =
"org.apache.tiles.factory.KeyedDefinitionsFactoryTilesContainerFactory.KEYS";
/**
* Init parameter name that contains the class name for the key extractor.
*/
public static final String KEY_EXTRACTOR_CLASS_INIT_PARAM =
"org.apache.tiles.impl.KeyedDefinitionsFactoryTilesContainer.KeyExtractor";
/**
* The application context.
*
* @since 2.1.0
*/
protected TilesApplicationContext applicationContext;
/** {@inheritDoc} */
@Override
public MutableTilesContainer createMutableTilesContainer(
TilesApplicationContext context) {
CachingKeyedDefinitionsFactoryTilesContainer container =
new CachingKeyedDefinitionsFactoryTilesContainer();
initializeContainer(context, container);
return container;
}
/** {@inheritDoc} */
@Override
public TilesContainer createTilesContainer(TilesApplicationContext context) {
KeyedDefinitionsFactoryTilesContainer container =
new KeyedDefinitionsFactoryTilesContainer();
initializeContainer(context, container);
return container;
}
/**
* Creates a definitions factory.
* @param context The context object to use.
* @return The newly created definitions factory.
* @throws TilesContainerFactoryException If something goes wrong.
* @deprecated Use
* {@link #createDefinitionsFactory(TilesApplicationContext)}.
*/
@Deprecated
public DefinitionsFactory createDefinitionsFactory(Object context) {
if (context instanceof TilesApplicationContext) {
createDefinitionsFactory((TilesApplicationContext) context);
}
throw new UnsupportedOperationException("Class "
+ context.getClass().getName()
+ " not recognized a TilesApplicationContext");
}
/**
* Creates a definitions factory.
* @param context The Tiles application context object to use.
* @return The newly created definitions factory.
* @throws TilesContainerFactoryException If something goes wrong.
*/
public DefinitionsFactory createDefinitionsFactory(
TilesApplicationContext context) {
DefinitionsFactory retValue;
Map<String, String> config = new HashMap<String, String>(defaultConfiguration);
config.putAll(context.getInitParams());
retValue = (DefinitionsFactory) createFactory(config,
DEFINITIONS_FACTORY_INIT_PARAM);
if (retValue instanceof TilesApplicationContextAware) {
((TilesApplicationContextAware) retValue)
.setApplicationContext(applicationContext);
}
return retValue;
}
/** {@inheritDoc} */
@Override
protected void storeContainerDependencies(Object context,
Map<String, String> initParameters,
Map<String, String> configuration, BasicTilesContainer container) {
super.storeContainerDependencies(context, initParameters, configuration, container);
String keyExtractorClassName = configuration.get(
KEY_EXTRACTOR_CLASS_INIT_PARAM);
if (keyExtractorClassName != null
&& container instanceof KeyedDefinitionsFactoryTilesContainer) {
((KeyedDefinitionsFactoryTilesContainer) container).setKeyExtractor(
(KeyExtractor) ClassUtil.instantiate(keyExtractorClassName));
}
}
/** {@inheritDoc} */
@Override
protected void postCreationOperations(TilesRequestContextFactory contextFactory,
TilesApplicationContext tilesContext,
RendererFactory rendererFactory, AttributeEvaluator evaluator,
Map<String, String> initParameters,
Map<String, String> configuration, BasicTilesContainer container) {
super.postCreationOperations(contextFactory, tilesContext,
rendererFactory, evaluator, initParameters, configuration,
container);
this.applicationContext = tilesContext;
String keysString = initParameters.get(CONTAINER_KEYS_INIT_PARAM);
if (keysString != null
&& container instanceof KeyedDefinitionsFactoryTilesContainer) {
String[] keys = keysString.split(",");
Map<String, String> initParams = new HashMap<String, String>(initParameters);
for (int i = 0; i < keys.length; i++) {
String param = initParameters.get(
KeyedDefinitionsFactoryTilesContainer.DEFINITIONS_CONFIG_PREFIX + keys[i]);
if (param != null) {
initParams.put(DefinitionsFactory.DEFINITIONS_CONFIG,
param);
} else {
initParams.remove(DefinitionsFactory.DEFINITIONS_CONFIG);
}
DefinitionsFactory defsFactory =
(DefinitionsFactory) createFactory(configuration,
DEFINITIONS_FACTORY_INIT_PARAM);
if (defsFactory instanceof TilesApplicationContextAware) {
((TilesApplicationContextAware) defsFactory).setApplicationContext(tilesContext);
}
defsFactory.init(initParams);
((KeyedDefinitionsFactoryTilesContainer) container)
.setDefinitionsFactory(keys[i], defsFactory);
}
}
}
}