org.apache.commons.chain.web.servlet: public class: RequestParameterMapper

org.apache.commons.chain.web.servlet
public class: RequestParameterMapper [javadoc | source]

java.lang.Object
   org.apache.commons.chain.generic.LookupCommand
      org.apache.commons.chain.web.servlet.RequestParameterMapper

All Implemented Interfaces:
Command, Filter

Command that uses a specified request parameter to select a Command from the appropriate Catalog , and execute it. To use this command, you would typically map an instance of ChainProcessor to a wildcard pattern like "*.execute" and then arrange that this is the default command to be executed. In such an environment, a request for the context-relative path "/foo.execute?command=bar" would cause the "/bar" command to be loaded and executed.

author: Craig - R. McClanahan

Method from org.apache.commons.chain.web.servlet.RequestParameterMapper Summary:
getCatalog, getCatalogKey, getCommandName, getParameter, setCatalogKey, setParameter

Methods from org.apache.commons.chain.generic.LookupCommand:
execute, getCatalog, getCatalogFactory, getCatalogName, getCommand, getCommandName, getName, getNameKey, isIgnoreExecuteResult, isIgnorePostprocessResult, isOptional, postprocess, setCatalogFactory, setCatalogName, setIgnoreExecuteResult, setIgnorePostprocessResult, setName, setNameKey, setOptional

Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method from org.apache.commons.chain.web.servlet.RequestParameterMapper Detail:
protected Catalog getCatalog(Context context) { Catalog catalog = (Catalog) context.get(getCatalogKey()); if (catalog == null) { catalog = super.getCatalog(context); } return catalog; } Return the Catalog to look up the Command in.
public String getCatalogKey() { // -------------------------------------------------------------- Properties return (this.catalogKey); } Return the context key under which our Catalog has been stored.
protected String getCommandName(Context context) { // Look up the specified request parameter for this request ServletWebContext swcontext = (ServletWebContext) context; HttpServletRequest request = swcontext.getRequest(); String value = request.getParameter(getParameter()); return value; } Look up the specified request paramater for this request, and use it to select an appropriate Command to be executed.
public String getParameter() { return (this.parameter); } Deprecated! `Use` - catalogName to specify the name of the catalog in the catalog factory Return the name of the request parameter to use for selecting the Command to be executed.
public void setCatalogKey(String catalogKey) { this.catalogKey = catalogKey; } Deprecated! `Use` - catalogName to specify the name of the catalog in the catalog factory Set the context key under which our Catalog has been stored.
public void setParameter(String parameter) { this.parameter = parameter; } Set the name of the request parameter to use for selecting the Command to be executed.

Method from org.apache.commons.chain.web.servlet.RequestParameterMapper Detail:

 protected Catalog getCatalog(Context context) {
        Catalog catalog = (Catalog) context.get(getCatalogKey());
        if (catalog == null) {
            catalog = super.getCatalog(context);
        }
        return catalog;
}

Return the Catalog to look up the Command in.

 public String getCatalogKey() {
    // -------------------------------------------------------------- Properties
        return (this.catalogKey);
}

Return the context key under which our Catalog has been stored.

 protected String getCommandName(Context context) {
        // Look up the specified request parameter for this request
        ServletWebContext swcontext = (ServletWebContext) context;
        HttpServletRequest request = swcontext.getRequest();
        String value = request.getParameter(getParameter());
        return value;
}

Look up the specified request paramater for this request, and use it to select an appropriate Command to be executed.

 public String getParameter() {
        return (this.parameter);
}

Deprecated! Use - catalogName to specify the name of the catalog in the catalog factory

Return the name of the request parameter to use for selecting the Command to be executed.

 public  void setCatalogKey(String catalogKey) {
        this.catalogKey = catalogKey;
}

Deprecated! Use - catalogName to specify the name of the catalog in the catalog factory

Set the context key under which our Catalog has been stored.

 public  void setParameter(String parameter) {
        this.parameter = parameter;
}

Set the name of the request parameter to use for selecting the Command to be executed.