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

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

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

All Implemented Interfaces:
Command, Filter

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

author: Craig - R. McClanahan

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

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.ServletPathMapper 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); } Deprecated! `Use` - catalogName to specify the name of the catalog in the catalog factory Return the context key under which our Catalog has been stored.
protected String getCommandName(Context context) { // Look up the servlet path for this request ServletWebContext swcontext = (ServletWebContext) context; HttpServletRequest request = swcontext.getRequest(); String servletPath = (String) request.getAttribute("javax.servlet.include.servlet_path"); if (servletPath == null) { servletPath = request.getServletPath(); } return servletPath; } Look up the servlet path information for this request, and use it to select an appropriate 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.

Method from org.apache.commons.chain.web.servlet.ServletPathMapper 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);
}

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

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

 protected String getCommandName(Context context) {
        // Look up the servlet path for this request
        ServletWebContext swcontext = (ServletWebContext) context;
        HttpServletRequest request = swcontext.getRequest();
        String servletPath = (String)
            request.getAttribute("javax.servlet.include.servlet_path");
        if (servletPath == null) {
            servletPath = request.getServletPath();
        }
        return servletPath;
}

Look up the servlet path information for this request, and use it to select an appropriate 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.