You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by hu...@apache.org on 2004/03/27 04:56:20 UTC
cvs commit: jakarta-commons-sandbox/chain/apps/mailreader/src/java/org/apache/commons/chain/mailreader ActionHelperBase.java ActionHelper.java ActionContextBase.java ActionContext.java
husted 2004/03/26 19:56:20
Added: chain/apps/mailreader/src/java/org/apache/commons/chain/mailreader
ActionHelperBase.java ActionHelper.java
Removed: chain/apps/mailreader/src/java/org/apache/commons/chain/mailreader
ActionContextBase.java ActionContext.java
Log:
Rename ActionContext as Helper objects.
Revision Changes Path
1.1 jakarta-commons-sandbox/chain/apps/mailreader/src/java/org/apache/commons/chain/mailreader/ActionHelperBase.java
Index: ActionHelperBase.java
===================================================================
/*
* $Header: /home/cvs/jakarta-commons-sandbox/chain/apps/mailreader/src/java/org/apache/commons/chain/mailreader/ActionHelperBase.java,v 1.1 2004/03/27 03:56:20 husted Exp $
* $Revision: 1.1 $
* $Date: 2004/03/27 03:56:20 $
*
* 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.commons.chain.mailreader;
import org.apache.commons.chain.impl.ContextBase;
import org.apache.struts.Globals;
import org.apache.struts.action.*;
import org.apache.struts.upload.MultipartRequestWrapper;
import org.apache.struts.util.MessageResources;
import org.apache.struts.util.RequestUtils;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import javax.sql.DataSource;
import java.util.Locale;
/**
* <p>
* NOTE -- This implementation was designed to work with the
* default module only. Many methods won't work with modular
* applications.
* </p>
* <p>
* NOTE -- In the next version, a "ViewContext" interface
* and implementation will be added to this class to allow
* access to operations business Commands might use without
* exposing Http signatures or other implementation details.
* </p>
* <p>
* NOTE -- At some point, a "disconnected" implementation should be
* available so that the Http resources do not have be cached
* as class members.
* </p>
* <p>
* NOTE -- This class may be migrated to a later release of Struts
* when support for Commons Chains is added.
* </p>
*/
public class ActionHelperBase implements ActionHelper {
// -------------------------------------------------------- Properties
/**
* 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 ActionHelperBase() {
super();
}
public ActionHelperBase(
ServletContext application,
HttpServletRequest request,
HttpServletResponse response) {
super();
this.setResources(application, request, response);
}
// ------------------------------------------------ Application Context
// See ActionHelper interface for JavaDoc
public DataSource getDataSource() {
if (this.application == null)
return null;
return (DataSource) this.application.getAttribute(Globals.DATA_SOURCE_KEY);
}
// See ActionHelper interface for JavaDoc
public ActionMessages getActionErrors() {
if (this.application == null)
return null;
return (ActionMessages) this.application.getAttribute(Globals.ERROR_KEY);
}
// See ActionHelper interface for JavaDoc
public ActionMessages getActionMessages() {
if (this.application == null)
return null;
return (ActionMessages) this.application.getAttribute(Globals.MESSAGE_KEY);
}
// See ActionHelper interface for JavaDoc
public MessageResources getMessageResources() {
if (this.application == null) {
return null;
}
return (MessageResources) this.application.getAttribute(Globals.MESSAGES_KEY);
}
// See ActionHelper interface for JavaDoc
public String getServletMapping() {
if (this.application == null) {
return null;
}
return (String) this.application.getAttribute(Globals.SERVLET_KEY);
}
// ---------------------------------------------------- Session Context
// See ActionHelper interface for JavaDoc
public Locale getLocale() {
if (this.session == null) {
return null;
}
return (Locale) session.getAttribute(Globals.LOCALE_KEY);
}
public void setLocale(Locale locale) {
session.setAttribute(Globals.LOCALE_KEY,locale);
}
// See ActionHelper interface for JavaDoc
public String getToken() {
if (this.session == null) {
return null;
}
return (String) session.getAttribute(Globals.TRANSACTION_TOKEN_KEY);
}
// ---------------------------------------------------- Request Context
// See ActionHelper interface for JavaDoc
public Throwable getException() {
if (this.request == null) {
return null;
}
return (Throwable) this.request.getAttribute(Globals.EXCEPTION_KEY);
}
// See ActionHelper interface for JavaDoc
public MultipartRequestWrapper getMultipartRequestWrapper() {
if (this.request == null) {
return null;
}
return (MultipartRequestWrapper) this.request.getAttribute(Globals.MULTIPART_KEY);
}
// See ActionHelper interface for JavaDoc
public ActionMapping getMapping() {
if (this.request == null) {
return null;
}
return (ActionMapping) this.request.getAttribute(Globals.MAPPING_KEY);
}
// ---------------------------------------------------- Utility Methods
// See ActionHelper interface for JavaDoc
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);
}
// See ActionHelper interface for JavaDoc
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;
}
// See ActionHelper interface for JavaDoc
// TODO:
public ActionFormBean getFormBean(String name) {
return null;
}
// See ActionHelper interface for JavaDoc
// TODO:
public ActionForward getActionForward(String name) {
return null;
}
// See ActionHelper interface for JavaDoc
// TODO:
public ActionMapping getActionMapping(String path) {
return null;
}
// See ActionHelper interface for JavaDoc
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);
}
// See ActionHelper interface for JavaDoc
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());
}
// See ActionHelper interface for JavaDoc
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
// See ActionHelper interface for JavaDoc
public String getOrigRef() {
// HttpServletRequest request = (HttpServletRequest)pageContext.getRequest();
if (request == null)
return null;
StringBuffer result = RequestUtils.requestToServerUriStringBuffer(request);
return result.toString();
}
// See ActionHelper interface for JavaDoc
public String getBaseRef() {
if (request == null)
return null;
StringBuffer result = RequestUtils.requestToServerStringBuffer(request);
String path = null;
if (forward == null)
path = request.getRequestURI();
else
path = request.getContextPath() + forward.getPath();
result.append(path);
return result.toString();
}
// See ActionHelper interface for JavaDoc
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());
}
// See ActionHelper interface for JavaDoc
public String getMessage(String key) {
MessageResources resources = getMessageResources();
if (resources == null)
return null;
return resources.getMessage(RequestUtils.getUserLocale(request, null), key);
}
// See ActionHelper interface for JavaDoc
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);
}
// See ActionHelper interface for JavaDoc
public String getAction(String path) {
return getEncodeURL(getActionMappingURL(path));
}
// --------------------------------------------- Presentation Wrappers
/**
* <p>Wrapper for getLink(String)</p>
* @param name Name given to local or global forward.
*/
public String link(String name) {
return getLink(name);
}
/**
* <p>Wrapper for getMessage(String)</p>
* @param key Message key
*/
public String message(String key) {
return getMessage(key);
}
/**
* <p>Wrapper for getMessage(String,Object[])</p>
* @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);
}
/**
* <p>Wrapper for getAction(String)</p>
* @param path Name given to local or global forward.
*/
public String action(String path) {
return getAction(path);
}
}
1.1 jakarta-commons-sandbox/chain/apps/mailreader/src/java/org/apache/commons/chain/mailreader/ActionHelper.java
Index: ActionHelper.java
===================================================================
/*
* $Header: /home/cvs/jakarta-commons-sandbox/chain/apps/mailreader/src/java/org/apache/commons/chain/mailreader/ActionHelper.java,v 1.1 2004/03/27 03:56:20 husted Exp $
* $Revision: 1.1 $
* $Date: 2004/03/27 03:56:20 $
*
* 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.commons.chain.mailreader;
import javax.sql.DataSource;
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 java.util.Locale;
/**
* <p>
* [This class is based on the experimental ConfigHelper class,
* and is under active development.]
* <p>
* A Context exposing the Struts shared resources,
* which are be stored in the application, session, or
* request contexts, as appropriate.
* </p>
* <p>
* An instance should be created for each request
* processed. The methods which return resources from
* the request or session contexts are not thread-safe.
* </p>
* <p>
* Provided for use by Commands and other components in the
* application so they can easily access the various Struts
* shared resources. These resources may be stored under
* attributes in the application, session, or request contexts,
* but users of this class do not need to know where.
* </p>
* <p>
* The ActionHelperBase methods simply return the resources
* from under the context and key used by the Struts
* ActionServlet when the resources are created.
* </p>
*/
public interface ActionHelper {
// ------------------------------------------------ Application Context
/**
* <p>
* The default DataSource instance registered with the
* ActionServlet, or <code>null</code> is none is registered.
* </p>
* @return The default DataSource instance or null
*/
public DataSource getDataSource();
/**
* <p>
* The collection of error messages for this request,
* or null if none are available.
* </p>
*/
public ActionMessages getActionErrors();
/**
* <p>
* The collection of general messages for this request,
* or null if none are available.
* </p>
*/
public ActionMessages getActionMessages();
/**
* <p>The application resources for this application.</p>
*/
public MessageResources getMessageResources();
/**
* <p>
* The path-mapped pattern (<code>/action/*</code>) or
* extension mapped pattern ((<code>*.do</code>)
* used to determine our Action URIs in this application.
* </p>
*/
public String getServletMapping();
// ---------------------------------------------------- Session Context
/**
* <p>
* The Locale associated with this client, or null if none.
* </p>
*/
public Locale getLocale();
/**
* <p>
* The transaction token stored in this session, if it is used.
* </p>
*/
public String getToken();
// ---------------------------------------------------- Request Context
/**
* <p>
* The runtime JspException that may be been thrown by a Struts tag
* extension, or compatible presentation extension, and placed
* in the request.
* </p>
*/
public Throwable getException();
/**
* <p>The multipart object for this request.</p>
*/
public MultipartRequestWrapper getMultipartRequestWrapper();
/**
* <p>
* The <code>org.apache.struts.ActionMapping</code>
* instance for this request.
* </p>
*/
public ActionMapping getMapping();
// ---------------------------------------------------- Utility Methods
/**
* <p>
* Return true if a message string for the specified message key
* is present for the clients's Locale.
* </p>
* @param key Message key
*/
public boolean isMessage(String key);
/**
* <p>
* Retrieve and return the <code>ActionForm</code> bean associated with
* this mapping. If there is no ActionForm present, return <code>null</code>.
* </p>
*/
public ActionForm getActionForm();
/**
* <p>
* Return the form bean definition associated with the specified
* logical name, if any; otherwise return <code>null</code>.
* </p>
* @param name Logical name of the requested form bean definition
*/
public ActionFormBean getFormBean(String name);
/**
* <p>
* Return the forwarding associated with the specified logical name,
* if any; otherwise return <code>null</code>.
* </p>
* @param name Logical name of the requested forwarding
*/
public ActionForward getActionForward(String name);
/**
* <p>
* Return the mapping associated with the specified request path, if any;
* otherwise return <code>null</code>.
* </p>
* @param path Request path for which a mapping is requested
*/
public ActionMapping getActionMapping(String path);
/**
* <p>
* Return the form action converted into an action mapping path. The
* value of the <code>action</code> property is manipulated as follows in
* computing the name of the requested mapping:
* </p>
* <ul>
* <li>
* Any filename extension is removed (on the theory that extension
* mapping is being used to select the controller servlet).
* </li>
* <li>
* If the resulting value does not start with a slash, then a
* slash is prepended.
* </li>
* </ul>
* <p>FIXME: Bad assumption =:o)</p>
*/
public String getActionMappingName(String action);
/**
* <p>
* Return the form action converted into a server-relative URL.
* </p>
*/
public String getActionMappingURL(String action);
/**
* <p>
* Return the url encoded to maintain the user session, if any.
* </p>
*/
public String getEncodeURL(String url);
// ------------------------------------------------ Presentation API
/**
* <p>Renders the reference for a HTML base element.</p>
*/
public String getOrigRef();
/**
* <p>Renders the reference for a HTML <base> element.</p>
*/
public String getBaseRef();
/**
* <p>
* Return the path for the specified forward,
* otherwise return <code>null</code>.
* </p>
* @param name Name given to local or global forward.
*/
public String getLink(String name);
/**
* <p>
* Return the localized message for the specified key,
* otherwise return <code>null</code>.
* </p>
* @param key Message key
*/
public String getMessage(String key);
/**
* <p>
* Look up and return a message string, based on the specified parameters.
* </p>
* @param key Message key to be looked up and returned
* @param args Replacement parameters for this message
*/
public String getMessage(String key, Object args[]);
/**
* <p>
* Return the URL for the specified ActionMapping,
* otherwise return <code>null</code>.
* </p>
* @param path Name given to local or global forward.
*/
public String getAction(String path);
}
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org