/*
* $Id: ModuleConfigImpl.java 471754 2006-11-06 14:55:09Z husted $
*
* 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.struts.config.impl;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.apache.struts.config.ActionConfig;
import org.apache.struts.config.ActionConfigMatcher;
import org.apache.struts.config.BaseConfig;
import org.apache.struts.config.ControllerConfig;
import org.apache.struts.config.ExceptionConfig;
import org.apache.struts.config.FormBeanConfig;
import org.apache.struts.config.ForwardConfig;
import org.apache.struts.config.MessageResourcesConfig;
import org.apache.struts.config.ModuleConfig;
import org.apache.struts.config.PlugInConfig;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
/**
* <p>The collection of static configuration information that describes a
* Struts-based module. Multiple modules are identified by a <em>prefix</em>
* at the beginning of the context relative portion of the request URI. If no
* module prefix can be matched, the default configuration (with a prefix
* equal to a zero-length string) is selected, which is elegantly backwards
* compatible with the previous Struts behavior that only supported one
* module.</p>
*
* @version $Rev: 471754 $ $Date: 2005-12-31 03:57:16 -0500 (Sat, 31 Dec 2005)
* $
* @since Struts 1.1
*/
public class ModuleConfigImpl extends BaseConfig implements Serializable,
ModuleConfig {
/**
* <p>Commons Logging instance. </p>
*/
protected static Log log = LogFactory.getLog(ModuleConfigImpl.class);
// ----------------------------------------------------- Instance Variables
// Instance Variables at end to make comparing Interface and implementation easier.
/**
* <p>The set of action configurations for this module, if any, keyed by
* the <code>path</code> property.</p>
*/
protected HashMap actionConfigs = null;
/**
* <p>The set of action configuration for this module, if any, keyed by
* the <code>actionId</code> property.</p>
*/
protected HashMap actionConfigIds = null;
/**
* <p>The set of action configurations for this module, if any, listed in
* the order in which they are added.</p>
*/
protected List actionConfigList = null;
/**
* <p>The set of exception handling configurations for this module, if
* any, keyed by the <code>type</code> property.</p>
*/
protected HashMap exceptions = null;
/**
* <p>The set of form bean configurations for this module, if any, keyed
* by the <code>name</code> property.</p>
*/
protected HashMap formBeans = null;
/**
* <p>The set of global forward configurations for this module, if any,
* keyed by the <code>name</code> property.</p>
*/
protected HashMap forwards = null;
/**
* <p>The set of message resources configurations for this module, if any,
* keyed by the <code>key</code> property.</p>
*/
protected HashMap messageResources = null;
/**
* <p>The set of configured plug-in Actions for this module, if any, in
* the order they were declared and configured.</p>
*/
protected ArrayList plugIns = null;
/**
* <p>The controller configuration object for this module.</p>
*/
protected ControllerConfig controllerConfig = null;
/**
* <p>The prefix of the context-relative portion of the request URI, used
* to select this configuration versus others supported by the controller
* servlet. A configuration with a prefix of a zero-length String is the
* default configuration for this web module.</p>
*/
protected String prefix = null;
/**
* <p>The default class name to be used when creating action form bean
* instances.</p>
*/
protected String actionFormBeanClass =
"org.apache.struts.action.ActionFormBean";
/**
* The default class name to be used when creating action mapping
* instances.
*/
protected String actionMappingClass =
"org.apache.struts.action.ActionMapping";
/**
* The default class name to be used when creating action forward
* instances.
*/
protected String actionForwardClass =
"org.apache.struts.action.ActionForward";
/**
* <p>Matches action config paths against compiled wildcard patterns</p>
*/
protected ActionConfigMatcher matcher = null;
/**
* <p>Constructor for ModuleConfigImpl. Assumes default
* configuration.</p>
*
* @since Struts 1.2.8
*/
public ModuleConfigImpl() {
this("");
}
/**
* <p>Construct an ModuleConfigImpl object according to the specified
* parameter values.</p>
*
* @param prefix Context-relative URI prefix for this module
*/
public ModuleConfigImpl(String prefix) {
super();
this.prefix = prefix;
this.actionConfigs = new HashMap();
this.actionConfigIds = new HashMap();
this.actionConfigList = new ArrayList();
this.actionFormBeanClass = "org.apache.struts.action.ActionFormBean";
this.actionMappingClass = "org.apache.struts.action.ActionMapping";
this.actionForwardClass = "org.apache.struts.action.ActionForward";
this.configured = false;
this.controllerConfig = null;
this.exceptions = new HashMap();
this.formBeans = new HashMap();
this.forwards = new HashMap();
this.messageResources = new HashMap();
this.plugIns = new ArrayList();
}
// --------------------------------------------------------- Public Methods
/**
* </p> Has this module been completely configured yet. Once this flag
* has been set, any attempt to modify the configuration will return an
* IllegalStateException.</p>
*/
public boolean getConfigured() {
return (this.configured);
}
/**
* <p>The controller configuration object for this module.</p>
*/
public ControllerConfig getControllerConfig() {
if (this.controllerConfig == null) {
this.controllerConfig = new ControllerConfig();
}
return (this.controllerConfig);
}
/**
* <p>The controller configuration object for this module.</p>
*
* @param cc The controller configuration object for this module.
*/
public void setControllerConfig(ControllerConfig cc) {
throwIfConfigured();
this.controllerConfig = cc;
}
/**
* <p>The prefix of the context-relative portion of the request URI, used
* to select this configuration versus others supported by the controller
* servlet. A configuration with a prefix of a zero-length String is the
* default configuration for this web module.</p>
*/
public String getPrefix() {
return (this.prefix);
}
/**
* <p>The prefix of the context-relative portion of the request URI, used
* to select this configuration versus others supported by the controller
* servlet. A configuration with a prefix of a zero-length String is the
* default configuration for this web module.</p>
*/
public void setPrefix(String prefix) {
throwIfConfigured();
this.prefix = prefix;
}
/**
* <p>The default class name to be used when creating action form bean
* instances.</p>
*/
public String getActionFormBeanClass() {
return this.actionFormBeanClass;
}
/**
* <p>The default class name to be used when creating action form bean
* instances.</p>
*
* @param actionFormBeanClass default class name to be used when creating
* action form bean instances.
*/
public void setActionFormBeanClass(String actionFormBeanClass) {
this.actionFormBeanClass = actionFormBeanClass;
}
/**
* <p>The default class name to be used when creating action mapping
* instances.</p>
*/
public String getActionMappingClass() {
return this.actionMappingClass;
}
/**
* <p> The default class name to be used when creating action mapping
* instances. </p>
*
* @param actionMappingClass default class name to be used when creating
* action mapping instances.
*/
public void setActionMappingClass(String actionMappingClass) {
this.actionMappingClass = actionMappingClass;
}
/**
* </p> Ad d a new <code>ActionConfig</code> instance to the set
* associated with this module. </p>
*
* @param config The new configuration instance to be added
* @throws IllegalStateException if this module configuration has been
* frozen
*/
public void addActionConfig(ActionConfig config) {
throwIfConfigured();
config.setModuleConfig(this);
String path = config.getPath();
if (actionConfigs.containsKey(path)) {
log.warn("Overriding ActionConfig of path " + path);
}
String actionId = config.getActionId();
if ((actionId != null) && !actionId.equals("")) {
if (actionConfigIds.containsKey(actionId)) {
if (log.isWarnEnabled()) {
ActionConfig otherConfig = (ActionConfig) actionConfigIds.get(actionId);
StringBuffer msg = new StringBuffer("Overriding actionId[");
msg.append(actionId);
msg.append("] for path[");
msg.append(otherConfig.getPath());
msg.append("] with path[");
msg.append(path);
msg.append("]");
log.warn(msg);
}
}
actionConfigIds.put(actionId, config);
}
actionConfigs.put(path, config);
actionConfigList.add(config);
}
/**
* <p> Add a new <code>ExceptionConfig</code> instance to the set
* associated with this module. </p>
*
* @param config The new configuration instance to be added
* @throws IllegalStateException if this module configuration has been
* frozen
*/
public void addExceptionConfig(ExceptionConfig config) {
throwIfConfigured();
String key = config.getType();
if (exceptions.containsKey(key)) {
log.warn("Overriding ExceptionConfig of type " + key);
}
exceptions.put(key, config);
}
/**
* <p> Add a new <code>FormBeanConfig</code> instance to the set
* associated with this module. </p>
*
* @param config The new configuration instance to be added
* @throws IllegalStateException if this module configuration has been
* frozen
*/
public void addFormBeanConfig(FormBeanConfig config) {
throwIfConfigured();
String key = config.getName();
if (formBeans.containsKey(key)) {
log.warn("Overriding ActionForm of name " + key);
}
formBeans.put(key, config);
}
/**
* <p> The default class name to be used when creating action forward
* instances. </p>
*/
public String getActionForwardClass() {
return this.actionForwardClass;
}
/**
* <p> The default class name to be used when creating action forward
* instances. </p>
*
* @param actionForwardClass default class name to be used when creating
* action forward instances.
*/
public void setActionForwardClass(String actionForwardClass) {
this.actionForwardClass = actionForwardClass;
}
/**
* <p> Add a new <code>ForwardConfig</code> instance to the set of global
* forwards associated with this module. </p>
*
* @param config The new configuration instance to be added
* @throws IllegalStateException if this module configuration has been
* frozen
*/
public void addForwardConfig(ForwardConfig config) {
throwIfConfigured();
String key = config.getName();
if (forwards.containsKey(key)) {
log.warn("Overriding global ActionForward of name " + key);
}
forwards.put(key, config);
}
/**
* <p> Add a new <code>MessageResourcesConfig</code> instance to the set
* associated with this module. </p>
*
* @param config The new configuration instance to be added
* @throws IllegalStateException if this module configuration has been
* frozen
*/
public void addMessageResourcesConfig(MessageResourcesConfig config) {
throwIfConfigured();
String key = config.getKey();
if (messageResources.containsKey(key)) {
log.warn("Overriding MessageResources bundle of key " + key);
}
messageResources.put(key, config);
}
/**
* <p> Add a newly configured {@link org.apache.struts.config.PlugInConfig}
* instance to the set of plug-in Actions for this module. </p>
*
* @param plugInConfig The new configuration instance to be added
*/
public void addPlugInConfig(PlugInConfig plugInConfig) {
throwIfConfigured();
plugIns.add(plugInConfig);
}
/**
* <p> Return the action configuration for the specified path, first
* looking a direct match, then if none found, a wildcard pattern match;
* otherwise return <code>null</code>. </p>
*
* @param path Path of the action configuration to return
*/
public ActionConfig findActionConfig(String path) {
ActionConfig config = (ActionConfig) actionConfigs.get(path);
// If a direct match cannot be found, try to match action configs
// containing wildcard patterns only if a matcher exists.
if ((config == null) && (matcher != null)) {
config = matcher.match(path);
}
return config;
}
/**
* <p>Returns the action configuration for the specifed action
* action identifier.</p>
*
* @param actionId the action identifier
* @return the action config if found; otherwise <code>null</code>
* @see ActionConfig#getActionId()
* @since Struts 1.3.6
*/
public ActionConfig findActionConfigId(String actionId) {
if (actionId != null) {
return (ActionConfig) this.actionConfigIds.get(actionId);
}
return null;
}
/**
* <p> Return the action configurations for this module. If there are
* none, a zero-length array is returned. </p>
*/
public ActionConfig[] findActionConfigs() {
ActionConfig[] results = new ActionConfig[actionConfigList.size()];
return ((ActionConfig[]) actionConfigList.toArray(results));
}
/**
* <p> Return the exception configuration for the specified type, if any;
* otherwise return <code>null</code>. </p>
*
* @param type Exception class name to find a configuration for
*/
public ExceptionConfig findExceptionConfig(String type) {
return ((ExceptionConfig) exceptions.get(type));
}
/**
* <p>Find and return the <code>ExceptionConfig</code> instance defining
* how <code>Exceptions</code> of the specified type should be handled.
*
* <p>In original Struts usage, this was only available in
* <code>ActionConfig</code>, but there are cases when an exception could
* be thrown before an <code>ActionConfig</code> has been identified,
* where global exception handlers may still be pertinent.</p>
*
* <p>TODO: Look for a way to share this logic with
* <code>ActionConfig</code>, although there are subtle differences, and
* it certainly doesn't seem like it should be done with inheritance.</p>
*
* @param type Exception class for which to find a handler
* @since Struts 1.3.0
*/
public ExceptionConfig findException(Class type) {
// Check through the entire superclass hierarchy as needed
ExceptionConfig config = null;
while (true) {
// Check for a locally defined handler
String name = type.getName();
log.debug("findException: look locally for " + name);
config = findExceptionConfig(name);
if (config != null) {
return (config);
}
// Loop again for our superclass (if any)
type = type.getSuperclass();
if (type == null) {
break;
}
}
return (null); // No handler has been configured
}
/**
* <p> Return the exception configurations for this module. If there are
* none, a zero-length array is returned. </p>
*/
public ExceptionConfig[] findExceptionConfigs() {
ExceptionConfig[] results = new ExceptionConfig[exceptions.size()];
return ((ExceptionConfig[]) exceptions.values().toArray(results));
}
/**
* <p> Return the form bean configuration for the specified key, if any;
* otherwise return <code>null</code>. </p>
*
* @param name Name of the form bean configuration to return
*/
public FormBeanConfig findFormBeanConfig(String name) {
return ((FormBeanConfig) formBeans.get(name));
}
/**
* <p> Return the form bean configurations for this module. If there are
* none, a zero-length array is returned. </p>
*/
public FormBeanConfig[] findFormBeanConfigs() {
FormBeanConfig[] results = new FormBeanConfig[formBeans.size()];
return ((FormBeanConfig[]) formBeans.values().toArray(results));
}
/**
* <p> Return the forward configuration for the specified key, if any;
* otherwise return <code>null</code>. </p>
*
* @param name Name of the forward configuration to return
*/
public ForwardConfig findForwardConfig(String name) {
return ((ForwardConfig) forwards.get(name));
}
/**
* <p> Return the form bean configurations for this module. If there are
* none, a zero-length array is returned. </p>
*/
public ForwardConfig[] findForwardConfigs() {
ForwardConfig[] results = new ForwardConfig[forwards.size()];
return ((ForwardConfig[]) forwards.values().toArray(results));
}
/**
* <p> Return the message resources configuration for the specified key,
* if any; otherwise return <code>null</code>. </p>
*
* @param key Key of the data source configuration to return
*/
public MessageResourcesConfig findMessageResourcesConfig(String key) {
return ((MessageResourcesConfig) messageResources.get(key));
}
/**
* <p> Return the message resources configurations for this module. If
* there are none, a zero-length array is returned. </p>
*/
public MessageResourcesConfig[] findMessageResourcesConfigs() {
MessageResourcesConfig[] results =
new MessageResourcesConfig[messageResources.size()];
return ((MessageResourcesConfig[]) messageResources.values().toArray(results));
}
/**
* <p> Return the configured plug-in actions for this module. If there
* are none, a zero-length array is returned. </p>
*/
public PlugInConfig[] findPlugInConfigs() {
PlugInConfig[] results = new PlugInConfig[plugIns.size()];
return ((PlugInConfig[]) plugIns.toArray(results));
}
/**
* <p> Freeze the configuration of this module. After this method
* returns, any attempt to modify the configuration will return an
* IllegalStateException. </p>
*/
public void freeze() {
super.freeze();
ActionConfig[] aconfigs = findActionConfigs();
for (int i = 0; i < aconfigs.length; i++) {
aconfigs[i].freeze();
}
matcher = new ActionConfigMatcher(aconfigs);
getControllerConfig().freeze();
ExceptionConfig[] econfigs = findExceptionConfigs();
for (int i = 0; i < econfigs.length; i++) {
econfigs[i].freeze();
}
FormBeanConfig[] fbconfigs = findFormBeanConfigs();
for (int i = 0; i < fbconfigs.length; i++) {
fbconfigs[i].freeze();
}
ForwardConfig[] fconfigs = findForwardConfigs();
for (int i = 0; i < fconfigs.length; i++) {
fconfigs[i].freeze();
}
MessageResourcesConfig[] mrconfigs = findMessageResourcesConfigs();
for (int i = 0; i < mrconfigs.length; i++) {
mrconfigs[i].freeze();
}
PlugInConfig[] piconfigs = findPlugInConfigs();
for (int i = 0; i < piconfigs.length; i++) {
piconfigs[i].freeze();
}
}
/**
* <p> Remove the specified action configuration instance. </p>
*
* @param config ActionConfig instance to be removed
* @throws IllegalStateException if this module configuration has been
* frozen
*/
public void removeActionConfig(ActionConfig config) {
throwIfConfigured();
config.setModuleConfig(null);
actionConfigs.remove(config.getPath());
actionConfigList.remove(config);
}
/**
* <p> Remove the specified exception configuration instance. </p>
*
* @param config ActionConfig instance to be removed
* @throws IllegalStateException if this module configuration has been
* frozen
*/
public void removeExceptionConfig(ExceptionConfig config) {
throwIfConfigured();
exceptions.remove(config.getType());
}
/**
* <p> Remove the specified form bean configuration instance. </p>
*
* @param config FormBeanConfig instance to be removed
* @throws IllegalStateException if this module configuration has been
* frozen
*/
public void removeFormBeanConfig(FormBeanConfig config) {
throwIfConfigured();
formBeans.remove(config.getName());
}
/**
* <p> Remove the specified forward configuration instance. </p>
*
* @param config ForwardConfig instance to be removed
* @throws IllegalStateException if this module configuration has been
* frozen
*/
public void removeForwardConfig(ForwardConfig config) {
throwIfConfigured();
forwards.remove(config.getName());
}
/**
* <p> Remove the specified message resources configuration instance.
* </p>
*
* @param config MessageResourcesConfig instance to be removed
* @throws IllegalStateException if this module configuration has been
* frozen
*/
public void removeMessageResourcesConfig(MessageResourcesConfig config) {
throwIfConfigured();
messageResources.remove(config.getKey());
}
}