A C D E F G H I K L M O P R S T V W

A

AbstractGetLocaleCommand - Class in org.apache.commons.chain.web

Abstract base Command implementation for retrieving the requested Locale from our Context, and storing it under the context attribute key returned by the localeKey property.

AbstractGetLocaleCommand() - Constructor for class org.apache.commons.chain.web.AbstractGetLocaleCommand

AbstractSetLocaleCommand - Class in org.apache.commons.chain.web

Abstract base Command implementation for setting the response locale for this response to the Locale stored under the context attribute key returned by the localeKey property.

AbstractSetLocaleCommand() - Constructor for class org.apache.commons.chain.web.AbstractSetLocaleCommand

addCatalog(String, Catalog) - Method in class org.apache.commons.chain.CatalogFactory

Adds a named instance of Catalog to the factory (for subsequent retrieval later).

addCatalog(String, Catalog) - Method in class org.apache.commons.chain.impl.CatalogFactoryBase

Adds a named instance of Catalog to the factory (for subsequent retrieval later).

addCommand(String, Command) - Method in interface org.apache.commons.chain.Catalog

Add a new name and associated Command or Chain to the set of named commands known to this Catalog, replacing any previous command for that name.

addCommand(Command) - Method in interface org.apache.commons.chain.Chain

Add a Command to the list of Commands that will be called in turn when this Chain's execute() method is called.

addCommand(String, Command) - Method in class org.apache.commons.chain.impl.CatalogBase

Add a new name and associated Command to the set of named commands known to this Catalog, replacing any previous command for that name.

addCommand(Command) - Method in class org.apache.commons.chain.impl.ChainBase

See the Chain JavaDoc.

addRuleInstances(Digester) - Method in class org.apache.commons.chain.config.ConfigRuleSet

Add the set of Rule instances defined in this RuleSet to the specified Digester instance, associating them with our namespace URI (if any).

C

Catalog - Interface in org.apache.commons.chain

A Catalog is a collection of named Commands (or Chains) that can be used to retrieve the set of commands that should be performed based on a symbolic identifier.

CATALOG - Static variable in class org.apache.commons.chain.web.servlet.ChainProcessor

The name of the servlet init parameter containing the name of the Catalog to use for processing incoming requests.

CATALOG_DEFAULT - Static variable in class org.apache.commons.chain.web.servlet.ChainProcessor

The default request attribute under which we expose the Catalog being used to subordinate Commands.

CATALOG_KEY - Static variable in interface org.apache.commons.chain.Catalog

A default context attribute for storing a default Catalog, provided as a convenience only.

CatalogBase - Class in org.apache.commons.chain.impl

Simple in-memory implementation of Catalog.

CatalogBase() - Constructor for class org.apache.commons.chain.impl.CatalogBase

Create an empty catalog.

CatalogBase(Map) - Constructor for class org.apache.commons.chain.impl.CatalogBase

Create a catalog whose commands are those specified in the given Map.

CatalogFactory - Class in org.apache.commons.chain

A CatalogFactory is a class used to store and retrieve Catalogs.

CatalogFactory() - Constructor for class org.apache.commons.chain.CatalogFactory

CatalogFactoryBase - Class in org.apache.commons.chain.impl

A simple implementation of CatalogFactory.

CatalogFactoryBase() - Constructor for class org.apache.commons.chain.impl.CatalogFactoryBase

Construct an empty instance of CatalogFactoryBase.

Chain - Interface in org.apache.commons.chain

A Chain represents a configured list of Commands that will be executed in order to perform processing on a specified Context.

ChainBase - Class in org.apache.commons.chain.impl

Convenience base class for Chain implementations.

ChainBase() - Constructor for class org.apache.commons.chain.impl.ChainBase

Construct a Chain with no configured Commands.

ChainBase(Command) - Constructor for class org.apache.commons.chain.impl.ChainBase

Construct a Chain configured with the specified Command.

ChainBase(Command[]) - Constructor for class org.apache.commons.chain.impl.ChainBase

Construct a Chain configured with the specified Commands.

ChainBase(Collection) - Constructor for class org.apache.commons.chain.impl.ChainBase

Construct a Chain configured with the specified Commands.

ChainListener - Class in org.apache.commons.chain.web

ServletContextListener that automatically scans chain configuration files in the current web application at startup time, and exposes the result in a Catalog under a specified servlet context attribute.

ChainListener() - Constructor for class org.apache.commons.chain.web.ChainListener

ChainProcessor - Class in org.apache.commons.chain.web.servlet

Custom subclass of ChainServlet that also dispatches incoming requests to a configurable Command loaded from the specified Catalog.

ChainProcessor() - Constructor for class org.apache.commons.chain.web.servlet.ChainProcessor

ChainServlet - Class in org.apache.commons.chain.web

Servlet that automatically scans chain configuration files in the current web application at startup time, and exposes the result in a Catalog under a specified servlet context attribute.

ChainServlet() - Constructor for class org.apache.commons.chain.web.ChainServlet

clear() - Static method in class org.apache.commons.chain.CatalogFactory

Clear all references to registered catalogs, as well as to the relevant class loader.

clear() - Method in class org.apache.commons.chain.impl.ContextBase

Override the default Map behavior to clear all keys and values except those corresponding to JavaBeans properties.

Command - Interface in org.apache.commons.chain

A Command encapsulates a unit of processing work to be performed, whose purpose is to examine and/or modify the state of a transaction that is represented by a Context.

COMMAND - Static variable in class org.apache.commons.chain.web.servlet.ChainProcessor

The name of the servlet init parameter containing the name of the Command (loaded from our configured Catalog to use for processing each incoming request.

commands - Variable in class org.apache.commons.chain.impl.CatalogBase

The map of named Commands, keyed by name.

commands - Variable in class org.apache.commons.chain.impl.ChainBase

The list of Commands configured for this Chain, in the order in which they may delegate processing to the remainder of the Chain.

CONFIG_ATTR - Static variable in class org.apache.commons.chain.web.ChainListener

The name of the context init parameter containing the name of the servlet context attribute under which our resulting Catalog will be stored.

CONFIG_ATTR - Static variable in class org.apache.commons.chain.web.ChainServlet

The name of the context init parameter containing the name of the servlet context attribute under which our resulting Catalog will be stored.

CONFIG_CLASS_RESOURCE - Static variable in class org.apache.commons.chain.web.ChainListener

The name of the context init parameter containing a comma-delimited list of class loader resources to be scanned.

CONFIG_CLASS_RESOURCE - Static variable in class org.apache.commons.chain.web.ChainServlet

The name of the context init parameter containing a comma-delimited list of class loader resources to be scanned.

CONFIG_WEB_RESOURCE - Static variable in class org.apache.commons.chain.web.ChainListener

The name of the context init parameter containing a comma-delimited list of web applicaton resources to be scanned.

CONFIG_WEB_RESOURCE - Static variable in class org.apache.commons.chain.web.ChainServlet

The name of the context init parameter containing a comma-delimited list of web applicaton resources to be scanned.

ConfigParser - Class in org.apache.commons.chain.config

Class to parse the contents of an XML configuration file (using Commons Digester) that defines and configures commands and command chains to be registered in a Catalog.

ConfigParser() - Constructor for class org.apache.commons.chain.config.ConfigParser

ConfigRuleSet - Class in org.apache.commons.chain.config

Digester RuleSet for configuring Chain of Responsibility command chains, and adding them to an appropriate Catalog.

ConfigRuleSet() - Constructor for class org.apache.commons.chain.config.ConfigRuleSet

containsValue(Object) - Method in class org.apache.commons.chain.impl.ContextBase

Override the default Map behavior to return true if the specified value is present in either the underlying Map or one of the local property values.

Context - Interface in org.apache.commons.chain

A Context represents the state information that is accessed and manipulated by the execution of a Command or a Chain.

context - Variable in class org.apache.commons.chain.web.portlet.PortletWebContext

The PortletContext for this web application.

context - Variable in class org.apache.commons.chain.web.servlet.ServletWebContext

The ServletContext for this web application.

ContextBase - Class in org.apache.commons.chain.impl

Convenience base class for Context implementations.

ContextBase() - Constructor for class org.apache.commons.chain.impl.ContextBase

Default, no argument constructor.

ContextBase(Map) - Constructor for class org.apache.commons.chain.impl.ContextBase

Initialize the contents of this Context by copying the values from the specified Map.

contextDestroyed(ServletContextEvent) - Method in class org.apache.commons.chain.web.ChainListener

Remove the configured Catalog from the servlet context attributes for this web application.

contextInitialized(ServletContextEvent) - Method in class org.apache.commons.chain.web.ChainListener

Scan the required chain configuration resources, assemble the configured chains into a Catalog, and expose it as a servlet context attribute under the specified key.

CONTINUE_PROCESSING - Static variable in interface org.apache.commons.chain.Command

Commands should return CONTINUE_PROCESSING if the processing of the given Context should be delegated to a subsequent Command in an enclosing Chain.

CopyCommand - Class in org.apache.commons.chain.generic

Copy a specified literal value, or a context attribute stored under the fromKey (if any), to the toKey.

CopyCommand() - Constructor for class org.apache.commons.chain.generic.CopyCommand

D

DEFAULT_SIGNATURE - Static variable in class org.apache.commons.chain.generic.DispatchCommand

The base implementation expects dispatch methods to take a Context as their only argument.

DELIMITER - Static variable in class org.apache.commons.chain.CatalogFactory

Values passed to the getCommand(String) method should use this as the delimiter between the "catalog" name and the "command" name.

destroy() - Method in class org.apache.commons.chain.web.ChainServlet

Clean up after ourselves as this application shuts down.

destroy() - Method in class org.apache.commons.chain.web.servlet.ChainProcessor

Clean up as this application is shut down.

DispatchCommand - Class in org.apache.commons.chain.generic

An abstract base command which uses introspection to look up a method to execute.

DispatchCommand() - Constructor for class org.apache.commons.chain.generic.DispatchCommand

DispatchLookupCommand - Class in org.apache.commons.chain.generic

This command combines elements of the LookupCommand with the DispatchCommand.

DispatchLookupCommand() - Constructor for class org.apache.commons.chain.generic.DispatchLookupCommand

Create an instance with an unspecified catalogFactory property.

DispatchLookupCommand(CatalogFactory) - Constructor for class org.apache.commons.chain.generic.DispatchLookupCommand

Create an instance and initialize the catalogFactory property to given factory.

E

entrySet() - Method in class org.apache.commons.chain.impl.ContextBase

Override the default Map behavior to return a Set that meets the specified default behavior except for attempts to remove the key for a property of the Context implementation class, which will throw UnsupportedOperationException.

equals(Object) - Method in class org.apache.commons.chain.web.MapEntry

Determines if this entry is equal to the passed object.

evaluateResult(Object) - Method in class org.apache.commons.chain.generic.DispatchCommand

Evaluate the result of the method invocation as a boolean value.

execute(Context) - Method in interface org.apache.commons.chain.Chain

Execute the processing represented by this Chain according to the following algorithm.

execute(Context) - Method in interface org.apache.commons.chain.Command

Execute a unit of processing work to be performed.

execute(Context) - Method in class org.apache.commons.chain.generic.CopyCommand

Copy a specified literal value, or a context attribute stored under the fromKey (if any), to the toKey.

execute(Context) - Method in class org.apache.commons.chain.generic.DispatchCommand

Look up the method specified by either "method" or "methodKey" and invoke it, returning a boolean value as interpreted by evaluateResult.

execute(Context) - Method in class org.apache.commons.chain.generic.DispatchLookupCommand

Look up the specified command, and (if found) execute it.

execute(Context) - Method in class org.apache.commons.chain.generic.LookupCommand

Look up the specified command, and (if found) execute it.

execute(Context) - Method in class org.apache.commons.chain.generic.RemoveCommand

Copy the specified source attribute to the specified destination attribute.

execute(Context) - Method in class org.apache.commons.chain.impl.ChainBase

See the Chain JavaDoc.

execute(Context) - Method in class org.apache.commons.chain.web.AbstractGetLocaleCommand

Retrieve the Locale for this request, and store it under the specified context attribute.

execute(Context) - Method in class org.apache.commons.chain.web.AbstractSetLocaleCommand

Retrieve the Locale stored under the specified context attribute key, and establish it on this response.

extractMethod(Context) - Method in class org.apache.commons.chain.generic.DispatchCommand

Extract the dispatch method.

F

FacesGetLocaleCommand - Class in org.apache.commons.chain.web.faces

Concrete implementation of AbstractGetLocaleCommand for the JavaServer Faces API.

FacesGetLocaleCommand() - Constructor for class org.apache.commons.chain.web.faces.FacesGetLocaleCommand

FacesSetLocaleCommand - Class in org.apache.commons.chain.web.faces

Concrete implementation of AbstractSetLocaleCommand for the JavaServer Faces API.

FacesSetLocaleCommand() - Constructor for class org.apache.commons.chain.web.faces.FacesSetLocaleCommand

FacesWebContext - Class in org.apache.commons.chain.web.faces

Concrete implementation of WebContext suitable for use in JavaServer Faces apps.

FacesWebContext() - Constructor for class org.apache.commons.chain.web.faces.FacesWebContext

Construct an uninitialized FacesWebContext instance.

FacesWebContext(FacesContext) - Constructor for class org.apache.commons.chain.web.faces.FacesWebContext

Construct a FacesWebContext instance that is initialized with the specified JavaServer Faces API objects.

Filter - Interface in org.apache.commons.chain

A Filter is a specialized Command that also expects the Chain that is executing it to call the postprocess() method if it called the execute() method.

frozen - Variable in class org.apache.commons.chain.impl.ChainBase

Flag indicating whether the configuration of our commands list has been frozen by a call to the execute() method.

G

get(Object) - Method in class org.apache.commons.chain.impl.ContextBase

Override the default Map behavior to return the value of a local property if the specified key matches a local property name.

getApplicationScope() - Method in class org.apache.commons.chain.web.faces.FacesWebContext

See the WebContext's Javadoc.

getApplicationScope() - Method in class org.apache.commons.chain.web.portlet.PortletWebContext

See the WebContext's Javadoc.

getApplicationScope() - Method in class org.apache.commons.chain.web.servlet.ServletWebContext

See the WebContext's Javadoc.

getApplicationScope() - Method in class org.apache.commons.chain.web.WebContext

Return a mutable Map that maps application scope attribute names to their values.

getArguments(Context) - Method in class org.apache.commons.chain.generic.DispatchCommand

Get the arguments to be passed into the dispatch method.

getArguments(Context) - Method in class org.apache.commons.chain.generic.DispatchLookupCommand

Get the arguments to be passed into the dispatch method.

getCatalog() - Method in class org.apache.commons.chain.CatalogFactory

Gets the default instance of Catalog associated with the factory (if any); otherwise, return null.

getCatalog(String) - Method in class org.apache.commons.chain.CatalogFactory

Retrieves a Catalog instance by name (if any); otherwise return null.

getCatalog(Context) - Method in class org.apache.commons.chain.generic.LookupCommand

Return the Catalog to look up the Command in.

getCatalog() - Method in class org.apache.commons.chain.impl.CatalogFactoryBase

Gets the default instance of Catalog associated with the factory (if any); otherwise, return null.

getCatalog(String) - Method in class org.apache.commons.chain.impl.CatalogFactoryBase

Retrieves a Catalog instance by name (if any); otherwise return null.

getCatalog(Context) - Method in class org.apache.commons.chain.web.servlet.PathInfoMapper

Return the Catalog to look up the Command in.

getCatalog(Context) - Method in class org.apache.commons.chain.web.servlet.RequestParameterMapper

Return the Catalog to look up the Command in.

getCatalog(Context) - Method in class org.apache.commons.chain.web.servlet.ServletPathMapper

Return the Catalog to look up the Command in.

getCatalogClass() - Method in class org.apache.commons.chain.config.ConfigRuleSet

Return the fully qualified Catalog implementation class.

getCatalogElement() - Method in class org.apache.commons.chain.config.ConfigRuleSet

Return the element name of a catalog element.

getCatalogFactory() - Method in class org.apache.commons.chain.generic.LookupCommand

Return the CatalogFactory from which lookups will be performed.

getCatalogKey() - Method in class org.apache.commons.chain.web.servlet.PathInfoMapper

Deprecated.

Use catalogName to specify the name of the catalog in the catalog factory

getCatalogKey() - Method in class org.apache.commons.chain.web.servlet.RequestParameterMapper

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

getCatalogKey() - Method in class org.apache.commons.chain.web.servlet.ServletPathMapper

Deprecated.

Use catalogName to specify the name of the catalog in the catalog factory

getCatalogName() - Method in class org.apache.commons.chain.generic.LookupCommand

Return the name of the Catalog to be searched, or null to search the default Catalog.

getChainClass() - Method in class org.apache.commons.chain.config.ConfigRuleSet

Return the fully qualified Chain implementation class.

getChainElement() - Method in class org.apache.commons.chain.config.ConfigRuleSet

Return the element name of a chain element.

getClassAttribute() - Method in class org.apache.commons.chain.config.ConfigRuleSet

Return the attribute name of a class attribute.

getCommand(String) - Method in interface org.apache.commons.chain.Catalog

Return the Command or Chain associated with the specified name, if any; otherwise, return null.

getCommand(String) - Method in class org.apache.commons.chain.CatalogFactory

Return a Command based on the given commandID.

getCommand(Context) - Method in class org.apache.commons.chain.generic.LookupCommand

Return the Command instance to be delegated to.

getCommand(String) - Method in class org.apache.commons.chain.impl.CatalogBase

Return the Command associated with the specified name, if any; otherwise, return null.

getCommandElement() - Method in class org.apache.commons.chain.config.ConfigRuleSet

Return the element name of a command element.

getCommandName(Context) - Method in class org.apache.commons.chain.generic.LookupCommand

Return the name of the Command instance to be delegated to.

getCommandName(Context) - Method in class org.apache.commons.chain.web.servlet.PathInfoMapper

Look up the extra path information for this request, and use it to select an appropriate Command to be executed.

getCommandName(Context) - Method in class org.apache.commons.chain.web.servlet.RequestParameterMapper

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

getCommandName(Context) - Method in class org.apache.commons.chain.web.servlet.ServletPathMapper

Look up the servlet path information for this request, and use it to select an appropriate Command to be executed.

getContext() - Method in class org.apache.commons.chain.web.faces.FacesWebContext

Return the FacesContext instance for the request associated with this FacesWebContext.

getContext() - Method in class org.apache.commons.chain.web.portlet.PortletWebContext

Return the PortletContext for this context.

getContext() - Method in class org.apache.commons.chain.web.servlet.ServletWebContext

Return the ServletContext for this context.

getCookies() - Method in class org.apache.commons.chain.web.faces.FacesWebContext

See the WebContext's Javadoc.

getCookies() - Method in class org.apache.commons.chain.web.portlet.PortletWebContext

Returns an empty Map - portlets don't support Cookies.

getCookies() - Method in class org.apache.commons.chain.web.servlet.ServletWebContext

See the WebContext's Javadoc.

getCookies() - Method in class org.apache.commons.chain.web.WebContext

Return an immutable Map that maps cookie names to the set of cookies specified in the request.

getDefineElement() - Method in class org.apache.commons.chain.config.ConfigRuleSet

Return the element name of a define element.

getDigester() - Method in class org.apache.commons.chain.config.ConfigParser

Return the Digester instance to be used for parsing, creating one if necessary.

getFromKey() - Method in class org.apache.commons.chain.generic.CopyCommand

Return the context attribute key for the source attribute.

getFromKey() - Method in class org.apache.commons.chain.generic.RemoveCommand

Return the context attribute key for the attribute.

getHeader() - Method in class org.apache.commons.chain.web.faces.FacesWebContext

See the WebContext's Javadoc.

getHeader() - Method in class org.apache.commons.chain.web.portlet.PortletWebContext

See the WebContext's Javadoc.

getHeader() - Method in class org.apache.commons.chain.web.servlet.ServletWebContext

See the WebContext's Javadoc.

getHeader() - Method in class org.apache.commons.chain.web.WebContext

Return an immutable Map that maps header names to the first (or only) header value (as a String).

getHeaderValues() - Method in class org.apache.commons.chain.web.faces.FacesWebContext

See the WebContext's Javadoc.

getHeaderValues() - Method in class org.apache.commons.chain.web.portlet.PortletWebContext

See the WebContext's Javadoc.

getHeaderValues() - Method in class org.apache.commons.chain.web.servlet.ServletWebContext

See the WebContext's Javadoc.

getHeaderValues() - Method in class org.apache.commons.chain.web.WebContext

Return an immutable Map that maps header names to the set of all values specified in the request (as a String array).

getInitParam() - Method in class org.apache.commons.chain.web.faces.FacesWebContext

See the WebContext's Javadoc.

getInitParam() - Method in class org.apache.commons.chain.web.portlet.PortletWebContext

See the WebContext's Javadoc.

getInitParam() - Method in class org.apache.commons.chain.web.servlet.ServletWebContext

See the WebContext's Javadoc.

getInitParam() - Method in class org.apache.commons.chain.web.WebContext

Return an immutable Map that maps context application initialization parameters to their values.

getInstance() - Static method in class org.apache.commons.chain.CatalogFactory

Return the singleton CatalogFactory instance for the relevant ClassLoader.

getKey() - Method in class org.apache.commons.chain.web.MapEntry

Gets the entry key.

getLocale(Context) - Method in class org.apache.commons.chain.web.AbstractGetLocaleCommand

Retrieve and return the Locale for this request.

getLocale(Context) - Method in class org.apache.commons.chain.web.faces.FacesGetLocaleCommand

Retrieve and return the Locale for this request.

getLocale(Context) - Method in class org.apache.commons.chain.web.portlet.PortletGetLocaleCommand

Retrieve and return the Locale for this request.

getLocale(Context) - Method in class org.apache.commons.chain.web.servlet.ServletGetLocaleCommand

Retrieve and return the Locale for this request.

getLocaleKey() - Method in class org.apache.commons.chain.web.AbstractGetLocaleCommand

Return the context attribute key under which we will store the request Locale.

getLocaleKey() - Method in class org.apache.commons.chain.web.AbstractSetLocaleCommand

Return the context attribute key under which we will retrieve the response Locale.

getMethod() - Method in class org.apache.commons.chain.generic.DispatchCommand

Return the method name.

getMethod() - Method in class org.apache.commons.chain.generic.DispatchLookupCommand

Return the method name.

getMethodKey() - Method in class org.apache.commons.chain.generic.DispatchCommand

Return the Context key for the method name.

getMethodKey() - Method in class org.apache.commons.chain.generic.DispatchLookupCommand

Return the Context key for the method name.

getName() - Method in class org.apache.commons.chain.generic.LookupCommand

Return the name of the Command that we will look up and delegate execution to.

getNameAttribute() - Method in class org.apache.commons.chain.config.ConfigRuleSet

Return the attribute name of a name attribute.

getNameKey() - Method in class org.apache.commons.chain.generic.LookupCommand

Return the context attribute key under which the Command name is stored.

getNames() - Method in interface org.apache.commons.chain.Catalog

Return an Iterator over the set of named commands known to this Catalog.

getNames() - Method in class org.apache.commons.chain.CatalogFactory

Return an Iterator over the set of named Catalogs known to this CatalogFactory.

getNames() - Method in class org.apache.commons.chain.impl.CatalogBase

Return an Iterator over the set of named commands known to this Catalog.

getNames() - Method in class org.apache.commons.chain.impl.CatalogFactoryBase

Return an Iterator over the set of named Catalogs known to this CatalogFactory.

getParam() - Method in class org.apache.commons.chain.web.faces.FacesWebContext

See the WebContext's Javadoc.

getParam() - Method in class org.apache.commons.chain.web.portlet.PortletWebContext

See the WebContext's Javadoc.

getParam() - Method in class org.apache.commons.chain.web.servlet.ServletWebContext

See the WebContext's Javadoc.

getParam() - Method in class org.apache.commons.chain.web.WebContext

Return an immutable Map that maps request parameter names to the first (or only) value (as a String).

getParameter() - Method in class org.apache.commons.chain.web.servlet.RequestParameterMapper

Deprecated.

Use catalogName to specify the name of the catalog in the catalog factory

getParamValues() - Method in class org.apache.commons.chain.web.faces.FacesWebContext

See the WebContext's Javadoc.

getParamValues() - Method in class org.apache.commons.chain.web.portlet.PortletWebContext

See the WebContext's Javadoc.

getParamValues() - Method in class org.apache.commons.chain.web.servlet.ServletWebContext

See the WebContext's Javadoc.

getParamValues() - Method in class org.apache.commons.chain.web.WebContext

Return an immutable Map that maps request parameter names to the set of all values (as a String array).

getRequest() - Method in class org.apache.commons.chain.web.portlet.PortletWebContext

Return the PortletRequest for this context.

getRequest() - Method in class org.apache.commons.chain.web.servlet.ServletWebContext

Return the HttpServletRequest for this context.

getRequestScope() - Method in class org.apache.commons.chain.web.faces.FacesWebContext

See the WebContext's Javadoc.

getRequestScope() - Method in class org.apache.commons.chain.web.portlet.PortletWebContext

See the WebContext's Javadoc.

getRequestScope() - Method in class org.apache.commons.chain.web.servlet.ServletWebContext

See the WebContext's Javadoc.

getRequestScope() - Method in class org.apache.commons.chain.web.WebContext

Return a mutable Map that maps request scope attribute names to their values.

getResponse() - Method in class org.apache.commons.chain.web.portlet.PortletWebContext

Return the PortletResponse for this context.

getResponse() - Method in class org.apache.commons.chain.web.servlet.ServletWebContext

Return the HttpServletResponse for this context.

getRuleSet() - Method in class org.apache.commons.chain.config.ConfigParser

Return the RuleSet to be used for configuring our Digester parsing rules, creating one if necessary.

getSessionScope() - Method in class org.apache.commons.chain.web.faces.FacesWebContext

See the WebContext's Javadoc.

getSessionScope() - Method in class org.apache.commons.chain.web.portlet.PortletWebContext

See the WebContext's Javadoc.

getSessionScope() - Method in class org.apache.commons.chain.web.servlet.ServletWebContext

See the WebContext's Javadoc.

getSessionScope() - Method in class org.apache.commons.chain.web.WebContext

Return a mutable Map that maps session scope attribute names to their values.

getSignature() - Method in class org.apache.commons.chain.generic.DispatchCommand

Return a Class[] describing the expected signature of the method.

getSignature() - Method in class org.apache.commons.chain.generic.DispatchLookupCommand

Return a Class[] describing the expected signature of the method.

getToKey() - Method in class org.apache.commons.chain.generic.CopyCommand

Return the context attribute key for the destination attribute.

getUseContextClassLoader() - Method in class org.apache.commons.chain.config.ConfigParser

Return the "use context class loader" flag.

getValue() - Method in class org.apache.commons.chain.generic.CopyCommand

Return the literal value to be copied.

getValue() - Method in class org.apache.commons.chain.web.MapEntry

Gets the entry value.

H

hashCode() - Method in class org.apache.commons.chain.web.MapEntry

Returns the hashcode for this entry.

I

init() - Method in class org.apache.commons.chain.web.ChainServlet

Create (if necessary) and configure a Catalog from the servlet init parameters that have been specified.

init() - Method in class org.apache.commons.chain.web.servlet.ChainProcessor

Cache the name of the command we should execute for each request.

initialize(FacesContext) - Method in class org.apache.commons.chain.web.faces.FacesWebContext

Initialize (or reinitialize) this FacesWebContext instance for the specified JavaServer Faces API objects.

initialize(PortletContext, PortletRequest, PortletResponse) - Method in class org.apache.commons.chain.web.portlet.PortletWebContext

Initialize (or reinitialize) this PortletWebContext instance for the specified Portlet API objects.

initialize(ServletContext, HttpServletRequest, HttpServletResponse) - Method in class org.apache.commons.chain.web.servlet.ServletWebContext

Initialize (or reinitialize) this ServletWebContext instance for the specified Servlet API objects.

isEmpty() - Method in class org.apache.commons.chain.impl.ContextBase

Override the default Map behavior to return true if the underlying Map only contains key-value pairs for local properties (if any).

isIgnoreExecuteResult() - Method in class org.apache.commons.chain.generic.LookupCommand

Return true if this command should ignore the return value from executing the looked-up command.

isIgnorePostprocessResult() - Method in class org.apache.commons.chain.generic.LookupCommand

Return true if this command is a Filter and should ignore the return value from executing the looked-up Filter's postprocess() method.

isOptional() - Method in class org.apache.commons.chain.generic.LookupCommand

Return true if locating the specified command is optional.

K

keySet() - Method in class org.apache.commons.chain.impl.ContextBase

Override the default Map behavior to return a Set that meets the specified default behavior except for attempts to remove the key for a property of the Context implementation class, which will throw UnsupportedOperationException.

L

LookupCommand - Class in org.apache.commons.chain.generic

Look up a specified Command (which could also be a Chain) in a Catalog, and delegate execution to it.

LookupCommand() - Constructor for class org.apache.commons.chain.generic.LookupCommand

Create an instance, setting its catalogFactory property to the value of CatalogFactory.getInstance().

LookupCommand(CatalogFactory) - Constructor for class org.apache.commons.chain.generic.LookupCommand

Create an instance and initialize the catalogFactory property to given factory/

M

MapEntry - Class in org.apache.commons.chain.web

Map.Entry implementation that can be constructed to either be read-only or not.

MapEntry(Object, Object, boolean) - Constructor for class org.apache.commons.chain.web.MapEntry

Creates a map entry that can either allow modifications or not.

O

org.apache.commons.chain - package org.apache.commons.chain

The fundamental API contracts for the Chain of Responsibilty Pattern as implemented in this package.

org.apache.commons.chain.config - package org.apache.commons.chain.config

Optional package for configuring command chains in a catalog (using Digester) from an XML configuration file.

org.apache.commons.chain.generic - package org.apache.commons.chain.generic

Concrete implementations of generic Commands that are useful in many different environments, not tied to a particular tier such as Servlets).

org.apache.commons.chain.impl - package org.apache.commons.chain.impl

Convenient base implementations of Chain of Responsibility Pattern contracts from org.apache.commons.chain.

org.apache.commons.chain.web - package org.apache.commons.chain.web

Basis for specialized Context implementations suitable for use in web applications, and generic Command implementations useful across web application environments.

org.apache.commons.chain.web.faces - package org.apache.commons.chain.web.faces

Specialized Context and Command implementations suitable for use in a JavaServer Faces API environment.

org.apache.commons.chain.web.portlet - package org.apache.commons.chain.web.portlet

Specialized Context and Command implementations suitable for use in a Portlet API environment.

org.apache.commons.chain.web.servlet - package org.apache.commons.chain.web.servlet

Specialized Context and Command implementations suitable for use in a Servlet API environment.

P

parse(Catalog, URL) - Method in class org.apache.commons.chain.config.ConfigParser

Deprecated.

Use parse(URL) on a configuration resource with "factory" element(s) embedded

parse(URL) - Method in class org.apache.commons.chain.config.ConfigParser

Parse the XML document at the specified URL using the configured RuleSet, registering catalogs with nested chains and commands as they are encountered.

PathInfoMapper - Class in org.apache.commons.chain.web.servlet

Command that uses the "path info" component of the request URI to select a Command from the appropriate Catalog, and execute it.

PathInfoMapper() - Constructor for class org.apache.commons.chain.web.servlet.PathInfoMapper

PortletGetLocaleCommand - Class in org.apache.commons.chain.web.portlet

Concrete implementation of AbstractGetLocaleCommand for the Portlet API.

PortletGetLocaleCommand() - Constructor for class org.apache.commons.chain.web.portlet.PortletGetLocaleCommand

PortletSetLocaleCommand - Class in org.apache.commons.chain.web.portlet

Concrete implementation of AbstractSetLocaleCommand for the Portlet API.

PortletSetLocaleCommand() - Constructor for class org.apache.commons.chain.web.portlet.PortletSetLocaleCommand

PortletWebContext - Class in org.apache.commons.chain.web.portlet

Concrete implementation of WebContext suitable for use in portlets.

PortletWebContext() - Constructor for class org.apache.commons.chain.web.portlet.PortletWebContext

Construct an uninitialized PortletWebContext instance.

PortletWebContext(PortletContext, PortletRequest, PortletResponse) - Constructor for class org.apache.commons.chain.web.portlet.PortletWebContext

Construct a PortletWebContext instance that is initialized with the specified Portlet API objects.

postprocess(Context, Exception) - Method in interface org.apache.commons.chain.Filter

Execute any cleanup activities, such as releasing resources that were acquired during the execute() method of this Filter instance.

postprocess(Context, Exception) - Method in class org.apache.commons.chain.generic.LookupCommand

If the executed command was itself a Filter, call the postprocess() method of that Filter as well.

PROCESSING_COMPLETE - Static variable in interface org.apache.commons.chain.Command

Commands should return PROCESSING_COMPLETE if the processing of the given Context has been completed.

put(Object, Object) - Method in class org.apache.commons.chain.impl.ContextBase

Override the default Map behavior to set the value of a local property if the specified key matches a local property name.

putAll(Map) - Method in class org.apache.commons.chain.impl.ContextBase

Override the default Map behavior to call the put() method individually for each key-value pair in the specified Map.

R

release() - Method in class org.apache.commons.chain.web.faces.FacesWebContext

Release references to allocated resources acquired in initialize() of via subsequent processing.

release() - Method in class org.apache.commons.chain.web.portlet.PortletWebContext

Release references to allocated resources acquired in initialize() of via subsequent processing.

release() - Method in class org.apache.commons.chain.web.servlet.ServletWebContext

Release references to allocated resources acquired in initialize() of via subsequent processing.

remove(Object) - Method in class org.apache.commons.chain.impl.ContextBase

Override the default Map behavior to throw UnsupportedOperationException on any attempt to remove a key that is the name of a local property.

RemoveCommand - Class in org.apache.commons.chain.generic

Remove any context attribute stored under the fromKey.

RemoveCommand() - Constructor for class org.apache.commons.chain.generic.RemoveCommand

request - Variable in class org.apache.commons.chain.web.portlet.PortletWebContext

The PortletRequest for this request.

request - Variable in class org.apache.commons.chain.web.servlet.ServletWebContext

The HttpServletRequest for this request.

RequestParameterMapper - Class in org.apache.commons.chain.web.servlet

Command that uses a specified request parameter to select a Command from the appropriate Catalog, and execute it.

RequestParameterMapper() - Constructor for class org.apache.commons.chain.web.servlet.RequestParameterMapper

response - Variable in class org.apache.commons.chain.web.portlet.PortletWebContext

The PortletResponse for this request.

response - Variable in class org.apache.commons.chain.web.servlet.ServletWebContext

The HttpServletResponse for this request.

RULE_SET - Static variable in class org.apache.commons.chain.web.ChainListener

The name of the context init parameter containing the fully qualified class name of the RuleSet implementation for configuring our ConfigParser.

RULE_SET - Static variable in class org.apache.commons.chain.web.ChainServlet

The name of the context init parameter containing the fully qualified class name of the RuleSet implementation for configuring our ConfigParser.

S

service(HttpServletRequest, HttpServletResponse) - Method in class org.apache.commons.chain.web.ChainServlet

Does nothing; this servlet's only purpose is to initialize a Chain and store it in the servlet context.

service(HttpServletRequest, HttpServletResponse) - Method in class org.apache.commons.chain.web.servlet.ChainProcessor

Configure a ServletWebContext for the current request, and pass it to the execute() method of the specified Command, loaded from our configured Catalog.

ServletGetLocaleCommand - Class in org.apache.commons.chain.web.servlet

Concrete implementation of AbstractGetLocaleCommand for the Servlet API.

ServletGetLocaleCommand() - Constructor for class org.apache.commons.chain.web.servlet.ServletGetLocaleCommand

ServletPathMapper - Class in org.apache.commons.chain.web.servlet

Command that uses the "servlet path" component of the request URI to select a Command from the appropriate Catalog, and execute it.

ServletPathMapper() - Constructor for class org.apache.commons.chain.web.servlet.ServletPathMapper

ServletSetLocaleCommand - Class in org.apache.commons.chain.web.servlet

Concrete implementation of AbstractSetLocaleCommand for the Servlet API.

ServletSetLocaleCommand() - Constructor for class org.apache.commons.chain.web.servlet.ServletSetLocaleCommand

ServletWebContext - Class in org.apache.commons.chain.web.servlet

Concrete implementation of WebContext suitable for use in Servlets and JSP pages.

ServletWebContext() - Constructor for class org.apache.commons.chain.web.servlet.ServletWebContext

Construct an uninitialized ServletWebContext instance.

ServletWebContext(ServletContext, HttpServletRequest, HttpServletResponse) - Constructor for class org.apache.commons.chain.web.servlet.ServletWebContext

Construct a ServletWebContext instance that is initialized with the specified Servlet API objects.

setCatalog(Catalog) - Method in class org.apache.commons.chain.CatalogFactory

Sets the default instance of Catalog associated with the factory.

setCatalog(Catalog) - Method in class org.apache.commons.chain.impl.CatalogFactoryBase

Sets the default instance of Catalog associated with the factory.

setCatalogClass(String) - Method in class org.apache.commons.chain.config.ConfigRuleSet

Set the fully qualified Catalog implementation class.

setCatalogElement(String) - Method in class org.apache.commons.chain.config.ConfigRuleSet

Set the element name of a catalog element.

setCatalogFactory(CatalogFactory) - Method in class org.apache.commons.chain.generic.LookupCommand

Set the CatalogFactory from which lookups will be performed.

setCatalogKey(String) - Method in class org.apache.commons.chain.web.servlet.PathInfoMapper

Deprecated.

Use catalogName to specify the name of the catalog in the catalog factory

setCatalogKey(String) - Method in class org.apache.commons.chain.web.servlet.RequestParameterMapper

Deprecated.

Use catalogName to specify the name of the catalog in the catalog factory

setCatalogKey(String) - Method in class org.apache.commons.chain.web.servlet.ServletPathMapper

Deprecated.

Use catalogName to specify the name of the catalog in the catalog factory

setCatalogName(String) - Method in class org.apache.commons.chain.generic.LookupCommand

Set the name of the Catalog to be searched, or null to search the default Catalog.

setChainClass(String) - Method in class org.apache.commons.chain.config.ConfigRuleSet

Set the fully qualified Chain implementation class.

setChainElement(String) - Method in class org.apache.commons.chain.config.ConfigRuleSet

Set the element name of a chain element.

setClassAttribute(String) - Method in class org.apache.commons.chain.config.ConfigRuleSet

Set the attribute name of a class attribute.

setCommandElement(String) - Method in class org.apache.commons.chain.config.ConfigRuleSet

Set the element name of a command element.

setDefineElement(String) - Method in class org.apache.commons.chain.config.ConfigRuleSet

Set the element name of a define element.

setFromKey(String) - Method in class org.apache.commons.chain.generic.CopyCommand

Set the context attribute key for the source attribute.

setFromKey(String) - Method in class org.apache.commons.chain.generic.RemoveCommand

Set the context attribute key for the attribute.

setIgnoreExecuteResult(boolean) - Method in class org.apache.commons.chain.generic.LookupCommand

Set the rules for whether or not this class will ignore or pass through the value returned from executing the looked up command.

setIgnorePostprocessResult(boolean) - Method in class org.apache.commons.chain.generic.LookupCommand

Set the rules for whether or not this class will ignore or pass through the value returned from executing the looked up Filter's postprocess() method.

setLocale(Context, Locale) - Method in class org.apache.commons.chain.web.AbstractSetLocaleCommand

Establish the specified Locale for this response.

setLocale(Context, Locale) - Method in class org.apache.commons.chain.web.faces.FacesSetLocaleCommand

Establish the specified Locale for this response.

setLocale(Context, Locale) - Method in class org.apache.commons.chain.web.portlet.PortletSetLocaleCommand

Establish the specified Locale for this response.

setLocale(Context, Locale) - Method in class org.apache.commons.chain.web.servlet.ServletSetLocaleCommand

Establish the specified Locale for this response.

setLocaleKey(String) - Method in class org.apache.commons.chain.web.AbstractGetLocaleCommand

Set the context attribute key under which we will store the request Locale.

setLocaleKey(String) - Method in class org.apache.commons.chain.web.AbstractSetLocaleCommand

Set the context attribute key under which we will retrieve the response Locale.

setMethod(String) - Method in class org.apache.commons.chain.generic.DispatchCommand

Set the method name.

setMethod(String) - Method in class org.apache.commons.chain.generic.DispatchLookupCommand

Set the method name.

setMethodKey(String) - Method in class org.apache.commons.chain.generic.DispatchCommand

Set the Context key for the method name.

setMethodKey(String) - Method in class org.apache.commons.chain.generic.DispatchLookupCommand

Set the Context key for the method name.

setName(String) - Method in class org.apache.commons.chain.generic.LookupCommand

Set the name of the Command that we will look up and delegate execution to.

setNameAttribute(String) - Method in class org.apache.commons.chain.config.ConfigRuleSet

Set the attribute name of a name attribute.

setNameKey(String) - Method in class org.apache.commons.chain.generic.LookupCommand

Set the context attribute key under which the Command name is stored.

setOptional(boolean) - Method in class org.apache.commons.chain.generic.LookupCommand

Set the optional flag for finding the specified command.

setParameter(String) - Method in class org.apache.commons.chain.web.servlet.RequestParameterMapper

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

setRuleSet(RuleSet) - Method in class org.apache.commons.chain.config.ConfigParser

Set the RuleSet to be used for configuring our Digester parsing rules.

setToKey(String) - Method in class org.apache.commons.chain.generic.CopyCommand

Set the context attribute key for the destination attribute.

setUseContextClassLoader(boolean) - Method in class org.apache.commons.chain.config.ConfigParser

Set the "use context class loader" flag.

setValue(String) - Method in class org.apache.commons.chain.generic.CopyCommand

Set the literal value to be copied.

setValue(Object) - Method in class org.apache.commons.chain.web.MapEntry

Sets the entry value if the entry can be modified.

T

toString() - Method in class org.apache.commons.chain.impl.CatalogBase

Converts this Catalog to a String.

V

values() - Method in class org.apache.commons.chain.impl.ContextBase

Override the default Map behavior to return a Collection that meets the specified default behavior except for attempts to remove the key for a property of the Context implementation class, which will throw UnsupportedOperationException.

W

WebContext - Class in org.apache.commons.chain.web

Abstract base implementation of Context that provides web based applications that use it a "generic" view of HTTP related requests and responses, without tying the application to a particular underlying Java API (such as servlets).

WebContext() - Constructor for class org.apache.commons.chain.web.WebContext

A C D E F G H I K L M O P R S T V W