org.apache.struts.config.ConfigHelperInterface Maven / Gradle / Ivy
/*
* $Id: ConfigHelperInterface.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;
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;
/**
* 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.
*
* @version $Rev: 471754 $ $Date: 2005-05-07 12:11:38 -0400 (Sat, 07 May 2005)
* $
* @since Struts 1.1
*/
public interface ConfigHelperInterface {
// ------------------------------------------------ Application Context
/**
* The org.apache.struts.action.ActionFormBeans
* collection for this application.
*/
public ActionMessages getActionMessages();
/**
* The application resources for this application.
*/
public MessageResources getMessageResources();
/**
* The path-mapped pattern (/action/*) or extension
* mapped pattern ((*.do) used to determine our Action URIs
* in this application.
*/
public String getServletMapping();
// ---------------------------------------------------- Session Context
/**
* The transaction token stored in this session, if it is used.
*/
public String getToken();
// ---------------------------------------------------- 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();
/**
* The multipart object for this request.
*/
public MultipartRequestWrapper getMultipartRequestWrapper();
/**
* The org.apache.struts.ActionMapping instance for this
* request.
*/
public ActionMapping getMapping();
// ---------------------------------------------------- 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);
/**
* 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();
/**
* 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 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 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 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.
*
*
:FIXME: Bad assumption =:o)
*/
public String getActionMappingName(String action);
/**
* Return the form action converted into a server-relative URL.
*/
public String getActionMappingURL(String action);
/**
* Return the url encoded to maintain the user session, if any.
*/
public String getEncodeURL(String url);
// ------------------------------------------------ Presentation API
/**
* Renders the reference for a HTML
*/
public String getOrigRef();
/**
* Renders the reference for a HTML
*/
public String getBaseRef();
/**
* Return the path for the specified forward, otherwise return
* null.
*
* @param name Name given to local or global forward.
*/
public String getLink(String name);
/**
* Return the localized message for the specified key, otherwise
* return null.
*
* @param key Message key
*/
public String getMessage(String 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);
/**
* Return the URL for the specified ActionMapping, otherwise return
* null.
*
* @param path Name given to local or global forward.
*/
public String getAction(String path);
}