Package org.apache.commons.chain.web.servlet

Class RequestParameterMapper

  • All Implemented Interfaces:
    Command, Filter
    public class RequestParameterMapper
extends LookupCommand
implements Command

    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

    • Field Detail

      • catalogKey

        private java.lang.String catalogKey

      • parameter

        private java.lang.String parameter

    • Constructor Detail

      • RequestParameterMapper

        public RequestParameterMapper()

    • Method Detail

      • getCatalogKey

        public java.lang.String getCatalogKey()

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

        Returns:
        The context key for the Catalog.

      • setCatalogKey

        public void setCatalogKey​(java.lang.String 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.

        Parameters:
        catalogKey - The new catalog key

      • getParameter

        public java.lang.String getParameter()
        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.

        Returns:
        The name of the request parameter.

      • setParameter

        public void setParameter​(java.lang.String parameter)

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

        Parameters:
        parameter - The new parameter name

      • getCommandName

        protected java.lang.String getCommandName​(Context context)

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

        Overrides:
        getCommandName in class LookupCommand
        Parameters:
        context - Context for the current request
        Returns:
        The name of the Command instance
        Since:
        Chain 1.2