org.apache.struts.config.ConfigHelper Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ibis-struts Show documentation
Show all versions of ibis-struts Show documentation
Base project: http://central.maven.org/maven2/struts/struts/1.2.9/
This version of Struts doesn't throw java.io.NotSerializableException when the application server wants to persist sessions and makes renderFocusJavascript return valid xml
The newest version!
/*
* $Id: ConfigHelper.java 54929 2004-10-16 16:38:42Z germuska $
*
* Copyright 1999-2004 The Apache Software Foundation.
*
* Licensed 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;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import javax.sql.DataSource;
import org.apache.struts.Globals;
import org.apache.struts.action.ActionForm;
import org.apache.struts.action.ActionFormBean;
import org.apache.struts.action.ActionForward;
import org.apache.struts.action.ActionMapping;
import org.apache.struts.action.ActionMessages;
import org.apache.struts.upload.MultipartRequestWrapper;
import org.apache.struts.util.MessageResources;
import org.apache.struts.util.RequestUtils;
/**
* NOTE: THIS CLASS IS UNDER ACTIVE DEVELOPMENT.
* THE CURRENT CODE IS WRITTEN FOR CLARITY NOT EFFICIENCY.
* NOT EVERY API FUNCTION HAS BEEN IMPLEMENTED YET.
*
* A helper object to expose the Struts shared resources,
* which are be stored in the application, session, or
* request contexts, as appropriate.
*
* An instance should be created for each request
* processed. The methods which return resources from
* the request or session contexts are not thread-safe.
*
* Provided for use by other servlets in the application
* so they can easily access the Struts shared resources.
*
* The resources are stored under attributes in the
* application, session, or request contexts.
*
* The ActionConfig methods simply return the resources
* from under the context and key used by the Struts
* ActionServlet when the resources are created.
*
* @since Struts 1.1
* @version $Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $
*/
public class ConfigHelper implements ConfigHelperInterface {
// -------------------------------------------------------- Properites
/**
* The application associated with this instance.
*/
private ServletContext application = null;
/**
* Set the application associated with this instance.
* [servlet.getServletContext()]
*/
public void setApplication(ServletContext application) {
this.application = application;
}
/**
* The session associated with this instance.
*/
private HttpSession session = null;
/**
* Set the session associated with this instance.
*/
public void setSession(HttpSession session) {
this.session = session;
}
/**
* The request associated with this instance.
*/
private HttpServletRequest request = null;
/**
* Set the request associated with this object.
* Session object is also set or cleared.
*/
public void setRequest(HttpServletRequest request) {
this.request = request;
if (this.request == null)
setSession(null);
else
setSession(this.request.getSession());
}
/**
* The response associated with this instance.
*/
private HttpServletResponse response = null;
/**
* Set the response associated with this isntance.
* Session object is also set or cleared.
*/
public void setResponse(HttpServletResponse response) {
this.response = response;
}
/**
* The forward associated with this instance.
*/
private ActionForward forward = null;
/**
* Set the forward associated with this instance.
*/
public void setForward(ActionForward forward) {
this.forward = forward;
}
/**
* Set the application and request for this object instance.
* The ServletContext can be set by any servlet in the application.
* The request should be the instant request.
* Most of the other methods retrieve their own objects
* by reference to the application, request, or session
* attributes.
* Do not call other methods without setting these first!
* This is also called by the convenience constructor.
*
* @param application - The associated ServletContext.
* @param request - The associated HTTP request.
* @param response - The associated HTTP response.
*/
public void setResources(
ServletContext application,
HttpServletRequest request,
HttpServletResponse response) {
setApplication(application);
setRequest(request);
setResponse(response);
}
public ConfigHelper() {
super();
}
public ConfigHelper(
ServletContext application,
HttpServletRequest request,
HttpServletResponse response) {
super();
this.setResources(application, request, response);
}
// ------------------------------------------------ Application Context
/**
* The default
* configured data source (which must implement
* javax.sql.DataSource),
* if one is configured for this application.
*/
public DataSource getDataSource() {
if (this.application == null)
return null;
return (DataSource) this.application.getAttribute(Globals.DATA_SOURCE_KEY);
}
public ActionMessages getActionMessages() {
if (this.application == null)
return null;
return (ActionMessages) this.application.getAttribute(Globals.MESSAGE_KEY);
}
/**
* The application resources for this application.
*/
public MessageResources getMessageResources() {
if (this.application == null) {
return null;
}
return (MessageResources) this.application.getAttribute(Globals.MESSAGES_KEY);
}
/**
* The path-mapped pattern (/action/*) or
* extension mapped pattern ((*.do)
* used to determine our Action URIs in this application.
*/
public String getServletMapping() {
if (this.application == null) {
return null;
}
return (String) this.application.getAttribute(Globals.SERVLET_KEY);
}
// ---------------------------------------------------- Session Context
/**
* The transaction token stored in this session, if it is used.
*/
public String getToken() {
if (this.session == null) {
return null;
}
return (String) session.getAttribute(Globals.TRANSACTION_TOKEN_KEY);
}
// ---------------------------------------------------- Request Context
/**
* The runtime JspException that may be been thrown by a Struts tag
* extension, or compatible presentation extension, and placed
* in the request.
*/
public Throwable getException() {
if (this.request == null) {
return null;
}
return (Throwable) this.request.getAttribute(Globals.EXCEPTION_KEY);
}
/**
* The multipart object for this request.
*/
public MultipartRequestWrapper getMultipartRequestWrapper() {
if (this.request == null) {
return null;
}
return (MultipartRequestWrapper) this.request.getAttribute(Globals.MULTIPART_KEY);
}
/**
* The org.apache.struts.ActionMapping
* instance for this request.
*/
public ActionMapping getMapping() {
if (this.request == null) {
return null;
}
return (ActionMapping) this.request.getAttribute(Globals.MAPPING_KEY);
}
// ---------------------------------------------------- Utility Methods
/**
* Return true if a message string for the specified message key
* is present for the user's Locale.
*
* @param key Message key
*/
public boolean isMessage(String key) {
// Look up the requested MessageResources
MessageResources resources = getMessageResources();
if (resources == null) {
return false;
}
// Return the requested message presence indicator
return resources.isPresent(RequestUtils.getUserLocale(request, null), key);
}
/*
* Retrieve and return the ActionForm bean associated with
* this mapping, creating and stashing one if necessary. If there is no
* form bean associated with this mapping, return null.
*
*/
public ActionForm getActionForm() {
// Is there a mapping associated with this request?
ActionMapping mapping = getMapping();
if (mapping == null)
return (null);
// Is there a form bean associated with this mapping?
String attribute = mapping.getAttribute();
if (attribute == null)
return (null);
// Look up the existing form bean, if any
ActionForm instance = null;
if ("request".equals(mapping.getScope())) {
instance = (ActionForm) this.request.getAttribute(attribute);
} else {
instance = (ActionForm) this.session.getAttribute(attribute);
}
return instance;
}
/**
* Return the form bean definition associated with the specified
* logical name, if any; otherwise return null.
*
* @param name Logical name of the requested form bean definition
*/
public ActionFormBean getFormBean(String name) {
return null;
}
/**
* Return the forwarding associated with the specified logical name,
* if any; otherwise return null.
*
* @param name Logical name of the requested forwarding
*/
public ActionForward getActionForward(String name) {
return null;
}
/**
* Return the mapping associated with the specified request path, if any;
* otherwise return null.
*
* @param path Request path for which a mapping is requested
*/
public ActionMapping getActionMapping(String path) {
return null;
}
/**
* Return the form action converted into an action mapping path. The
* value of the action property is manipulated as follows in
* computing the name of the requested mapping:
*
* - Any filename extension is removed (on the theory that extension
* mapping is being used to select the controller servlet).
* - If the resulting value does not start with a slash, then a
* slash is prepended.
*
*/
public String getActionMappingName(String action) {
String value = action;
int question = action.indexOf("?");
if (question >= 0)
value = value.substring(0, question);
int slash = value.lastIndexOf("/");
int period = value.lastIndexOf(".");
if ((period >= 0) && (period > slash))
value = value.substring(0, period);
if (value.startsWith("/"))
return (value);
else
return ("/" + value);
}
/**
* Return the form action converted into a server-relative URL.
*/
public String getActionMappingURL(String action) {
StringBuffer value = new StringBuffer(this.request.getContextPath());
// Use our servlet mapping, if one is specified
String servletMapping = getServletMapping();
if (servletMapping != null) {
String queryString = null;
int question = action.indexOf("?");
if (question >= 0)
queryString = action.substring(question);
String actionMapping = getActionMappingName(action);
if (servletMapping.startsWith("*.")) {
value.append(actionMapping);
value.append(servletMapping.substring(1));
} else if (servletMapping.endsWith("/*")) {
value.append(servletMapping.substring(0, servletMapping.length() - 2));
value.append(actionMapping);
}
if (queryString != null)
value.append(queryString);
}
// Otherwise, assume extension mapping is in use and extension is
// already included in the action property
else {
if (!action.startsWith("/"))
value.append("/");
value.append(action);
}
// Return the completed value
return (value.toString());
}
/**
* Return the url encoded to maintain the user session, if any.
*/
public String getEncodeURL(String url) {
if ((session != null) && (response != null)) {
boolean redirect = false;
if (forward != null)
redirect = forward.getRedirect();
if (redirect)
return response.encodeRedirectURL(url);
else
return response.encodeURL(url);
} else
return (url);
}
// ------------------------------------------------ Presentation API
/**
* Renders the reference for a HTML null.
*
* @param name Name given to local or global forward.
*/
public String getLink(String name) {
ActionForward forward = getActionForward(name);
if (forward == null)
return null;
StringBuffer path = new StringBuffer(this.request.getContextPath());
path.append(forward.getPath());
// :TODO: What about runtime parameters?
return getEncodeURL(path.toString());
}
/**
* Return the localized message for the specified key,
* otherwise return null.
*
* @param key Message key
*/
public String getMessage(String key) {
MessageResources resources = getMessageResources();
if (resources == null)
return null;
return resources.getMessage(RequestUtils.getUserLocale(request, null), key);
}
/**
* Look up and return a message string, based on the specified parameters.
*
* @param key Message key to be looked up and returned
* @param args Replacement parameters for this message
*/
public String getMessage(String key, Object args[]) {
MessageResources resources = getMessageResources();
if (resources == null)
return null;
// Return the requested message
if (args == null)
return resources.getMessage(
RequestUtils.getUserLocale(request, null),
key);
else
return resources.getMessage(
RequestUtils.getUserLocale(request, null),
key,
args);
}
/**
* Return the URL for the specified ActionMapping,
* otherwise return null.
*
* @param path Name given to local or global forward.
*/
public String getAction(String path) {
return getEncodeURL(getActionMappingURL(path));
}
// --------------------------------------------- Presentation Wrappers
/**
* Wrapper for getLink(String)
*
* @param name Name given to local or global forward.
*/
public String link(String name) {
return getLink(name);
}
/**
* Wrapper for getMessage(String)
*
* @param key Message key
*/
public String message(String key) {
return getMessage(key);
}
/**
* Wrapper for getMessage(String,Object[])
*
* @param key Message key to be looked up and returned
* @param args Replacement parameters for this message
*/
public String message(String key, Object args[]) {
return getMessage(key, args);
}
/**
* Wrapper for getAction(String)
*
* @param path Name given to local or global forward.
*/
public String action(String path) {
return getAction(path);
}
}