A B C D E F G H I K L M N O P R S T U V W Z
All Classes All Packages
All Classes All Packages
All Classes All Packages
A
- AbstractGetLocaleCommand - Class in org.apache.commons.chain.web
- 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 theLocale
stored under the context attribute key returned by thelocaleKey
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
- addCommand(String, Command) - Method in class org.apache.commons.chain.impl.CatalogBase
- addCommand(Command) - Method in interface org.apache.commons.chain.Chain
- 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). - applicationScope - Variable in class org.apache.commons.chain.web.portlet.PortletWebContext
-
The lazily instantiated
Map
of application scope attributes. - applicationScope - Variable in class org.apache.commons.chain.web.servlet.ServletWebContext
-
The lazily instantiated
Map
of application scope attributes. - attribute - Variable in class org.apache.commons.chain.web.servlet.ChainProcessor
-
The name of the context attribute under which our
Catalog
is stored.
B
- begin(String, String, Attributes) - Method in class org.apache.commons.chain.config.ConfigCatalogRule
- begin(String, String, Attributes) - Method in class org.apache.commons.chain.config.ConfigDefineRule
-
Register new rules for the specified name and class.
- begin(String, String, Attributes) - Method in class org.apache.commons.chain.config.ConfigRegisterRule
-
Register the top
Command
if appropriate.
C
- catalog - Variable in class org.apache.commons.chain.impl.CatalogFactoryBase
-
The default
Catalog
for thisCatalogFactory
. - catalog - Variable in class org.apache.commons.chain.web.servlet.ChainProcessor
-
The name of the
Catalog
to retrieve from theCatalogFactory
for this application, ornull
to select the defaultCatalog
. - Catalog - Interface in org.apache.commons.chain
- 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
- 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
. - catalogClass - Variable in class org.apache.commons.chain.config.ConfigCatalogRule
-
The fully qualified class name of a
Catalog
class to use for instantiating new instances. - catalogClass - Variable in class org.apache.commons.chain.config.ConfigRuleSet
- catalogElement - Variable in class org.apache.commons.chain.config.ConfigRuleSet
- catalogFactory - Variable in class org.apache.commons.chain.generic.LookupCommand
- CatalogFactory - Class in org.apache.commons.chain
-
A
CatalogFactory
is a class used to store and retrieveCatalog
s. - 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
. - catalogKey - Variable in class org.apache.commons.chain.web.servlet.PathInfoMapper
- catalogKey - Variable in class org.apache.commons.chain.web.servlet.RequestParameterMapper
- catalogKey - Variable in class org.apache.commons.chain.web.servlet.ServletPathMapper
- catalogName - Variable in class org.apache.commons.chain.generic.LookupCommand
- catalogs - Variable in class org.apache.commons.chain.impl.CatalogFactoryBase
-
Map of named
Catalog
s, keyed by catalog name. - Chain - Interface in org.apache.commons.chain
- ChainBase - Class in org.apache.commons.chain.impl
-
Convenience base class for
Chain
implementations. - ChainBase() - Constructor for class org.apache.commons.chain.impl.ChainBase
- ChainBase(Collection) - Constructor for class org.apache.commons.chain.impl.ChainBase
- ChainBase(Command) - Constructor for class org.apache.commons.chain.impl.ChainBase
- ChainBase(Command[]) - Constructor for class org.apache.commons.chain.impl.ChainBase
- chainClass - Variable in class org.apache.commons.chain.config.ConfigRuleSet
- chainElement - Variable in class org.apache.commons.chain.config.ConfigRuleSet
- 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 aCatalog
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 configurableCommand
loaded from the specifiedCatalog
. - ChainProcessor() - Constructor for class org.apache.commons.chain.web.servlet.ChainProcessor
- ChainResources - Class in org.apache.commons.chain.web
-
Utility methods for loading class loader and web application resources to configure a
Catalog
. - ChainResources() - Constructor for class org.apache.commons.chain.web.ChainResources
- 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 aCatalog
under a specified servlet context attribute. - ChainServlet() - Constructor for class org.apache.commons.chain.web.ChainServlet
- classAttribute - Variable in class org.apache.commons.chain.config.ConfigDefineRule
-
The name of the attribute under which we can retrieve the fully qualified class name of the implementation class for this new element.
- classAttribute - Variable in class org.apache.commons.chain.config.ConfigRuleSet
- 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. - clear() - Method in class org.apache.commons.chain.impl.ContextBase.EntrySetImpl
- clear() - Method in class org.apache.commons.chain.impl.ContextBase.ValuesImpl
- clear() - Method in class org.apache.commons.chain.web.portlet.PortletApplicationScopeMap
- clear() - Method in class org.apache.commons.chain.web.portlet.PortletInitParamMap
- clear() - Method in class org.apache.commons.chain.web.portlet.PortletParamMap
- clear() - Method in class org.apache.commons.chain.web.portlet.PortletParamValuesMap
- clear() - Method in class org.apache.commons.chain.web.portlet.PortletRequestScopeMap
- clear() - Method in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- clear() - Method in class org.apache.commons.chain.web.servlet.ServletApplicationScopeMap
- clear() - Method in class org.apache.commons.chain.web.servlet.ServletCookieMap
- clear() - Method in class org.apache.commons.chain.web.servlet.ServletHeaderMap
- clear() - Method in class org.apache.commons.chain.web.servlet.ServletHeaderValuesMap
- clear() - Method in class org.apache.commons.chain.web.servlet.ServletInitParamMap
- clear() - Method in class org.apache.commons.chain.web.servlet.ServletParamMap
- clear() - Method in class org.apache.commons.chain.web.servlet.ServletParamValuesMap
- clear() - Method in class org.apache.commons.chain.web.servlet.ServletRequestScopeMap
- clear() - Method in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
- command - Variable in class org.apache.commons.chain.web.servlet.ChainProcessor
-
The name of the
Command
to be executed for each incoming request. - Command - Interface in org.apache.commons.chain
- COMMAND - Static variable in class org.apache.commons.chain.web.servlet.ChainProcessor
- COMMAND_DEFAULT - Static variable in class org.apache.commons.chain.web.servlet.ChainProcessor
-
The default command name.
- commandElement - Variable in class org.apache.commons.chain.config.ConfigRuleSet
- commands - Variable in class org.apache.commons.chain.impl.CatalogBase
-
The map of named
Command
s, keyed by name. - commands - Variable in class org.apache.commons.chain.impl.ChainBase
- 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.
- ConfigCatalogRule - Class in org.apache.commons.chain.config
-
Digester rule that will cause the top-most element on the Digester stack (if it is a
Catalog
to be registered with theCatalogFactory
instance for our application. - ConfigCatalogRule(String, String) - Constructor for class org.apache.commons.chain.config.ConfigCatalogRule
-
Construct a new instance of this rule that looks for an attribute with the specified name.
- ConfigDefineRule - Class in org.apache.commons.chain.config
-
Digester rule that will dynamically register a new set of rules for a specified element name and default implementation class.
- ConfigDefineRule(String, String) - Constructor for class org.apache.commons.chain.config.ConfigDefineRule
-
Construct a new instance of this rule that will in turn dynamically register appropriate rules for a new alias element.
- 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
- ConfigRegisterRule - Class in org.apache.commons.chain.config
- ConfigRegisterRule(String) - Constructor for class org.apache.commons.chain.config.ConfigRegisterRule
-
Construct a new instance of this rule that looks for an attribute with the specified name.
- ConfigRuleSet - Class in org.apache.commons.chain.config
-
Digester
RuleSet
for configuring Chain of Responsibility command chains, and adding them to an appropriateCatalog
. - ConfigRuleSet() - Constructor for class org.apache.commons.chain.config.ConfigRuleSet
- contains(Object) - Method in class org.apache.commons.chain.impl.ContextBase.EntrySetImpl
- contains(Object) - Method in class org.apache.commons.chain.impl.ContextBase.ValuesImpl
- containsKey(Object) - Method in class org.apache.commons.chain.web.portlet.PortletApplicationScopeMap
- containsKey(Object) - Method in class org.apache.commons.chain.web.portlet.PortletInitParamMap
- containsKey(Object) - Method in class org.apache.commons.chain.web.portlet.PortletParamMap
- containsKey(Object) - Method in class org.apache.commons.chain.web.portlet.PortletParamValuesMap
- containsKey(Object) - Method in class org.apache.commons.chain.web.portlet.PortletRequestScopeMap
- containsKey(Object) - Method in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- containsKey(Object) - Method in class org.apache.commons.chain.web.servlet.ServletApplicationScopeMap
- containsKey(Object) - Method in class org.apache.commons.chain.web.servlet.ServletCookieMap
- containsKey(Object) - Method in class org.apache.commons.chain.web.servlet.ServletHeaderMap
- containsKey(Object) - Method in class org.apache.commons.chain.web.servlet.ServletHeaderValuesMap
- containsKey(Object) - Method in class org.apache.commons.chain.web.servlet.ServletInitParamMap
- containsKey(Object) - Method in class org.apache.commons.chain.web.servlet.ServletParamMap
- containsKey(Object) - Method in class org.apache.commons.chain.web.servlet.ServletParamValuesMap
- containsKey(Object) - Method in class org.apache.commons.chain.web.servlet.ServletRequestScopeMap
- containsKey(Object) - Method in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
- containsValue(Object) - Method in class org.apache.commons.chain.impl.ContextBase
-
Override the default
Map
behavior to returntrue
if the specified value is present in either the underlyingMap
or one of the local property values. - containsValue(Object) - Method in class org.apache.commons.chain.web.portlet.PortletApplicationScopeMap
- containsValue(Object) - Method in class org.apache.commons.chain.web.portlet.PortletInitParamMap
- containsValue(Object) - Method in class org.apache.commons.chain.web.portlet.PortletParamMap
- containsValue(Object) - Method in class org.apache.commons.chain.web.portlet.PortletParamValuesMap
- containsValue(Object) - Method in class org.apache.commons.chain.web.portlet.PortletRequestScopeMap
- containsValue(Object) - Method in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- containsValue(Object) - Method in class org.apache.commons.chain.web.servlet.ServletApplicationScopeMap
- containsValue(Object) - Method in class org.apache.commons.chain.web.servlet.ServletCookieMap
- containsValue(Object) - Method in class org.apache.commons.chain.web.servlet.ServletHeaderMap
- containsValue(Object) - Method in class org.apache.commons.chain.web.servlet.ServletHeaderValuesMap
- containsValue(Object) - Method in class org.apache.commons.chain.web.servlet.ServletInitParamMap
- containsValue(Object) - Method in class org.apache.commons.chain.web.servlet.ServletParamMap
- containsValue(Object) - Method in class org.apache.commons.chain.web.servlet.ServletParamValuesMap
- containsValue(Object) - Method in class org.apache.commons.chain.web.servlet.ServletRequestScopeMap
- containsValue(Object) - Method in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
- context - Variable in class org.apache.commons.chain.web.portlet.PortletApplicationScopeMap
- context - Variable in class org.apache.commons.chain.web.portlet.PortletInitParamMap
- 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.ServletApplicationScopeMap
- context - Variable in class org.apache.commons.chain.web.servlet.ServletInitParamMap
- context - Variable in class org.apache.commons.chain.web.servlet.ServletWebContext
-
The
ServletContext
for this web application. - Context - Interface in org.apache.commons.chain
- 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 specifiedMap
. - ContextBase.EntrySetImpl - Class in org.apache.commons.chain.impl
-
Private implementation of
Set
that implements the semantics required for the value returned byentrySet()
. - ContextBase.EntrySetIterator - Class in org.apache.commons.chain.impl
-
Private implementation of
Iterator
for theSet
returned byentrySet()
. - ContextBase.MapEntryImpl - Class in org.apache.commons.chain.impl
-
Private implementation of
Map.Entry
for each item inEntrySetImpl
. - ContextBase.ValuesImpl - Class in org.apache.commons.chain.impl
-
Private implementation of
Collection
that implements the semantics required for the value returned byvalues()
. - ContextBase.ValuesIterator - Class in org.apache.commons.chain.impl
-
Private implementation of
Iterator
for theCollection
returned byvalues()
. - 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
- cookieValues - Variable in class org.apache.commons.chain.web.servlet.ServletWebContext
-
The lazily instantiated
Map
of cookies. - CopyCommand - Class in org.apache.commons.chain.generic
-
Copy a specified literal value, or a context attribute stored under the
fromKey
(if any), to thetoKey
. - 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. - DEFAULT_SIGNATURE - Static variable in class org.apache.commons.chain.generic.DispatchLookupCommand
-
The base implementation expects dispatch methods to take a
Context
as their only argument. - defineElement - Variable in class org.apache.commons.chain.config.ConfigRuleSet
- 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. - descriptors - Variable in class org.apache.commons.chain.impl.ContextBase
-
The
PropertyDescriptor
s for all JavaBeans properties of thisContext
implementation class, keyed by property 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.
- digester - Variable in class org.apache.commons.chain.config.ConfigParser
-
The
Digester
to be used for parsing. - 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 theDispatchCommand
. - 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 givenfactory
.
E
- entriesIterator() - Method in class org.apache.commons.chain.impl.ContextBase
-
Return an
Iterator
over the set ofMap.Entry
objects representing our key-value pairs. - entry - Variable in class org.apache.commons.chain.impl.ContextBase.EntrySetIterator
- entry - Variable in class org.apache.commons.chain.impl.ContextBase.ValuesIterator
- entry(Object) - Method in class org.apache.commons.chain.impl.ContextBase
-
Return a
Map.Entry
for the specified key value, if it is present; otherwise, returnnull
. - entrySet() - Method in class org.apache.commons.chain.impl.ContextBase
-
Override the default
Map
behavior to return aSet
that meets the specified default behavior except for attempts to remove the key for a property of theContext
implementation class, which will throwUnsupportedOperationException
. - entrySet() - Method in class org.apache.commons.chain.web.portlet.PortletApplicationScopeMap
- entrySet() - Method in class org.apache.commons.chain.web.portlet.PortletInitParamMap
- entrySet() - Method in class org.apache.commons.chain.web.portlet.PortletParamMap
- entrySet() - Method in class org.apache.commons.chain.web.portlet.PortletParamValuesMap
- entrySet() - Method in class org.apache.commons.chain.web.portlet.PortletRequestScopeMap
- entrySet() - Method in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- entrySet() - Method in class org.apache.commons.chain.web.servlet.ServletApplicationScopeMap
- entrySet() - Method in class org.apache.commons.chain.web.servlet.ServletCookieMap
- entrySet() - Method in class org.apache.commons.chain.web.servlet.ServletHeaderMap
- entrySet() - Method in class org.apache.commons.chain.web.servlet.ServletHeaderValuesMap
- entrySet() - Method in class org.apache.commons.chain.web.servlet.ServletInitParamMap
- entrySet() - Method in class org.apache.commons.chain.web.servlet.ServletParamMap
- entrySet() - Method in class org.apache.commons.chain.web.servlet.ServletParamValuesMap
- entrySet() - Method in class org.apache.commons.chain.web.servlet.ServletRequestScopeMap
- entrySet() - Method in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
- EntrySetImpl() - Constructor for class org.apache.commons.chain.impl.ContextBase.EntrySetImpl
- EntrySetIterator() - Constructor for class org.apache.commons.chain.impl.ContextBase.EntrySetIterator
- equals(Object) - Method in class org.apache.commons.chain.impl.ContextBase.MapEntryImpl
- equals(Object) - Method in class org.apache.commons.chain.web.MapEntry
-
Determines if this entry is equal to the passed object.
- equals(Object) - Method in class org.apache.commons.chain.web.portlet.PortletApplicationScopeMap
- equals(Object) - Method in class org.apache.commons.chain.web.portlet.PortletInitParamMap
- equals(Object) - Method in class org.apache.commons.chain.web.portlet.PortletParamMap
- equals(Object) - Method in class org.apache.commons.chain.web.portlet.PortletParamValuesMap
- equals(Object) - Method in class org.apache.commons.chain.web.portlet.PortletRequestScopeMap
- equals(Object) - Method in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- equals(Object) - Method in class org.apache.commons.chain.web.servlet.ServletApplicationScopeMap
- equals(Object) - Method in class org.apache.commons.chain.web.servlet.ServletCookieMap
- equals(Object) - Method in class org.apache.commons.chain.web.servlet.ServletHeaderMap
- equals(Object) - Method in class org.apache.commons.chain.web.servlet.ServletHeaderValuesMap
- equals(Object) - Method in class org.apache.commons.chain.web.servlet.ServletInitParamMap
- equals(Object) - Method in class org.apache.commons.chain.web.servlet.ServletParamMap
- equals(Object) - Method in class org.apache.commons.chain.web.servlet.ServletParamValuesMap
- equals(Object) - Method in class org.apache.commons.chain.web.servlet.ServletRequestScopeMap
- equals(Object) - Method in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
- 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 thetoKey
. - 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(Command, Context) - Method in class org.apache.commons.chain.generic.DispatchLookupCommand
-
Extract the dispatch method.
- extractMethod(Context) - Method in class org.apache.commons.chain.generic.DispatchCommand
-
Extract the dispatch method.
F
- factories - Static variable in class org.apache.commons.chain.CatalogFactory
-
The set of registered
CatalogFactory
instances, keyed by the relevant class loader. - Filter - Interface in org.apache.commons.chain
- fromKey - Variable in class org.apache.commons.chain.generic.CopyCommand
- fromKey - Variable in class org.apache.commons.chain.generic.RemoveCommand
- 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. - get(Object) - Method in class org.apache.commons.chain.web.portlet.PortletApplicationScopeMap
- get(Object) - Method in class org.apache.commons.chain.web.portlet.PortletInitParamMap
- get(Object) - Method in class org.apache.commons.chain.web.portlet.PortletParamMap
- get(Object) - Method in class org.apache.commons.chain.web.portlet.PortletParamValuesMap
- get(Object) - Method in class org.apache.commons.chain.web.portlet.PortletRequestScopeMap
- get(Object) - Method in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- get(Object) - Method in class org.apache.commons.chain.web.servlet.ServletApplicationScopeMap
- get(Object) - Method in class org.apache.commons.chain.web.servlet.ServletCookieMap
- get(Object) - Method in class org.apache.commons.chain.web.servlet.ServletHeaderMap
- get(Object) - Method in class org.apache.commons.chain.web.servlet.ServletHeaderValuesMap
- get(Object) - Method in class org.apache.commons.chain.web.servlet.ServletInitParamMap
- get(Object) - Method in class org.apache.commons.chain.web.servlet.ServletParamMap
- get(Object) - Method in class org.apache.commons.chain.web.servlet.ServletParamValuesMap
- get(Object) - Method in class org.apache.commons.chain.web.servlet.ServletRequestScopeMap
- get(Object) - Method in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
- 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() - 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.CatalogFactory
-
Retrieves a Catalog instance by name (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.generic.LookupCommand
- getCatalog(Context) - Method in class org.apache.commons.chain.web.servlet.PathInfoMapper
- getCatalog(Context) - Method in class org.apache.commons.chain.web.servlet.RequestParameterMapper
- getCatalog(Context) - Method in class org.apache.commons.chain.web.servlet.ServletPathMapper
- 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
- 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.
- getClassLoader() - Static method in class org.apache.commons.chain.CatalogFactory
-
Return the relevant
ClassLoader
to use as a Map key for this request. - getCommand(String) - Method in interface org.apache.commons.chain.Catalog
- getCommand(String) - Method in class org.apache.commons.chain.CatalogFactory
-
Return a
Command
based on the given commandID. - getCommand(String) - Method in class org.apache.commons.chain.impl.CatalogBase
-
Return the
Command
associated with the specified name, if any; otherwise, returnnull
. - getCommand(Context) - Method in class org.apache.commons.chain.generic.LookupCommand
-
Return the
Command
instance to be delegated to. - 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. - getCommands() - Method in class org.apache.commons.chain.impl.ChainBase
- 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.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.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.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.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 relevantClassLoader
. - getKey() - Method in class org.apache.commons.chain.impl.ContextBase.MapEntryImpl
- 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.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 thisCatalog
. - getNames() - Method in class org.apache.commons.chain.CatalogFactory
- getNames() - Method in class org.apache.commons.chain.impl.CatalogBase
-
Return an
Iterator
over the set of named commands known to thisCatalog
. - getNames() - Method in class org.apache.commons.chain.impl.CatalogFactoryBase
- 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.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.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. - getResourcePaths(String) - Static method in class org.apache.commons.chain.web.ChainResources
-
Parse the resource string into an array of paths.
- 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 ourDigester
parsing rules, creating one if necessary. - 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.impl.ContextBase.MapEntryImpl
- getValue() - Method in class org.apache.commons.chain.web.MapEntry
-
Gets the entry value.
H
- hashCode() - Method in class org.apache.commons.chain.impl.ContextBase.MapEntryImpl
- hashCode() - Method in class org.apache.commons.chain.web.MapEntry
-
Returns the hashcode for this entry.
- hashCode() - Method in class org.apache.commons.chain.web.portlet.PortletApplicationScopeMap
- hashCode() - Method in class org.apache.commons.chain.web.portlet.PortletInitParamMap
- hashCode() - Method in class org.apache.commons.chain.web.portlet.PortletParamMap
- hashCode() - Method in class org.apache.commons.chain.web.portlet.PortletParamValuesMap
- hashCode() - Method in class org.apache.commons.chain.web.portlet.PortletRequestScopeMap
- hashCode() - Method in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- hashCode() - Method in class org.apache.commons.chain.web.servlet.ServletApplicationScopeMap
- hashCode() - Method in class org.apache.commons.chain.web.servlet.ServletCookieMap
- hashCode() - Method in class org.apache.commons.chain.web.servlet.ServletHeaderMap
- hashCode() - Method in class org.apache.commons.chain.web.servlet.ServletHeaderValuesMap
- hashCode() - Method in class org.apache.commons.chain.web.servlet.ServletInitParamMap
- hashCode() - Method in class org.apache.commons.chain.web.servlet.ServletParamMap
- hashCode() - Method in class org.apache.commons.chain.web.servlet.ServletParamValuesMap
- hashCode() - Method in class org.apache.commons.chain.web.servlet.ServletRequestScopeMap
- hashCode() - Method in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
- hasNext() - Method in class org.apache.commons.chain.impl.ContextBase.EntrySetIterator
- hasNext() - Method in class org.apache.commons.chain.impl.ContextBase.ValuesIterator
- header - Variable in class org.apache.commons.chain.web.portlet.PortletWebContext
-
The lazily instantiated
Map
of header name-value combinations (immutable). - header - Variable in class org.apache.commons.chain.web.servlet.ServletWebContext
-
The lazily instantiated
Map
of header name-value combinations (immutable). - headerValues - Variable in class org.apache.commons.chain.web.portlet.PortletWebContext
-
The lazily instantitated
Map
of header name-values combinations (immutable). - headerValues - Variable in class org.apache.commons.chain.web.servlet.ServletWebContext
-
The lazily instantitated
Map
of header name-values combinations (immutable).
I
- ignoreExecuteResult - Variable in class org.apache.commons.chain.generic.LookupCommand
- ignorePostprocessResult - Variable in class org.apache.commons.chain.generic.LookupCommand
- 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() - Method in class org.apache.commons.chain.impl.ContextBase
-
Customize the contents of our underlying
Map
so that it contains keys corresponding to all of the JavaBeans properties of theContext
implementation class. - 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. - initParam - Variable in class org.apache.commons.chain.web.portlet.PortletWebContext
-
The lazily instantiated
Map
of context initialization parameters. - initParam - Variable in class org.apache.commons.chain.web.servlet.ServletWebContext
-
The lazily instantiated
Map
of context initialization parameters. - isEmpty() - Method in class org.apache.commons.chain.impl.ContextBase.EntrySetImpl
- isEmpty() - Method in class org.apache.commons.chain.impl.ContextBase
-
Override the default
Map
behavior to returntrue
if the underlyingMap
only contains key-value pairs for local properties (if any). - isEmpty() - Method in class org.apache.commons.chain.impl.ContextBase.ValuesImpl
- isEmpty() - Method in class org.apache.commons.chain.web.portlet.PortletApplicationScopeMap
- isEmpty() - Method in class org.apache.commons.chain.web.portlet.PortletInitParamMap
- isEmpty() - Method in class org.apache.commons.chain.web.portlet.PortletParamMap
- isEmpty() - Method in class org.apache.commons.chain.web.portlet.PortletParamValuesMap
- isEmpty() - Method in class org.apache.commons.chain.web.portlet.PortletRequestScopeMap
- isEmpty() - Method in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- isEmpty() - Method in class org.apache.commons.chain.web.servlet.ServletApplicationScopeMap
- isEmpty() - Method in class org.apache.commons.chain.web.servlet.ServletCookieMap
- isEmpty() - Method in class org.apache.commons.chain.web.servlet.ServletHeaderMap
- isEmpty() - Method in class org.apache.commons.chain.web.servlet.ServletHeaderValuesMap
- isEmpty() - Method in class org.apache.commons.chain.web.servlet.ServletInitParamMap
- isEmpty() - Method in class org.apache.commons.chain.web.servlet.ServletParamMap
- isEmpty() - Method in class org.apache.commons.chain.web.servlet.ServletParamValuesMap
- isEmpty() - Method in class org.apache.commons.chain.web.servlet.ServletRequestScopeMap
- isEmpty() - Method in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
- 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'spostprocess()
method. - isOptional() - Method in class org.apache.commons.chain.generic.LookupCommand
-
Return
true
if locating the specified command is optional. - iterator() - Method in class org.apache.commons.chain.impl.ContextBase.EntrySetImpl
- iterator() - Method in class org.apache.commons.chain.impl.ContextBase.ValuesImpl
K
- key - Variable in class org.apache.commons.chain.impl.ContextBase.MapEntryImpl
- key - Variable in class org.apache.commons.chain.web.MapEntry
-
The entry key.
- key(Object) - Method in class org.apache.commons.chain.web.portlet.PortletApplicationScopeMap
- key(Object) - Method in class org.apache.commons.chain.web.portlet.PortletInitParamMap
- key(Object) - Method in class org.apache.commons.chain.web.portlet.PortletParamMap
- key(Object) - Method in class org.apache.commons.chain.web.portlet.PortletParamValuesMap
- key(Object) - Method in class org.apache.commons.chain.web.portlet.PortletRequestScopeMap
- key(Object) - Method in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- key(Object) - Method in class org.apache.commons.chain.web.servlet.ServletApplicationScopeMap
- key(Object) - Method in class org.apache.commons.chain.web.servlet.ServletCookieMap
- key(Object) - Method in class org.apache.commons.chain.web.servlet.ServletHeaderMap
- key(Object) - Method in class org.apache.commons.chain.web.servlet.ServletHeaderValuesMap
- key(Object) - Method in class org.apache.commons.chain.web.servlet.ServletInitParamMap
- key(Object) - Method in class org.apache.commons.chain.web.servlet.ServletParamMap
- key(Object) - Method in class org.apache.commons.chain.web.servlet.ServletParamValuesMap
- key(Object) - Method in class org.apache.commons.chain.web.servlet.ServletRequestScopeMap
- key(Object) - Method in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
- keys - Variable in class org.apache.commons.chain.impl.ContextBase.EntrySetIterator
- keys - Variable in class org.apache.commons.chain.impl.ContextBase.ValuesIterator
- keySet() - Method in class org.apache.commons.chain.impl.ContextBase
-
Override the default
Map
behavior to return aSet
that meets the specified default behavior except for attempts to remove the key for a property of theContext
implementation class, which will throwUnsupportedOperationException
. - keySet() - Method in class org.apache.commons.chain.web.portlet.PortletApplicationScopeMap
- keySet() - Method in class org.apache.commons.chain.web.portlet.PortletInitParamMap
- keySet() - Method in class org.apache.commons.chain.web.portlet.PortletParamMap
- keySet() - Method in class org.apache.commons.chain.web.portlet.PortletParamValuesMap
- keySet() - Method in class org.apache.commons.chain.web.portlet.PortletRequestScopeMap
- keySet() - Method in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- keySet() - Method in class org.apache.commons.chain.web.servlet.ServletApplicationScopeMap
- keySet() - Method in class org.apache.commons.chain.web.servlet.ServletCookieMap
- keySet() - Method in class org.apache.commons.chain.web.servlet.ServletHeaderMap
- keySet() - Method in class org.apache.commons.chain.web.servlet.ServletHeaderValuesMap
- keySet() - Method in class org.apache.commons.chain.web.servlet.ServletInitParamMap
- keySet() - Method in class org.apache.commons.chain.web.servlet.ServletParamMap
- keySet() - Method in class org.apache.commons.chain.web.servlet.ServletParamValuesMap
- keySet() - Method in class org.apache.commons.chain.web.servlet.ServletRequestScopeMap
- keySet() - Method in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
L
- localeKey - Variable in class org.apache.commons.chain.web.AbstractGetLocaleCommand
-
The context attribute key used to store the
Locale
. - localeKey - Variable in class org.apache.commons.chain.web.AbstractSetLocaleCommand
-
The context attribute key used to retrieve the
Locale
. - LookupCommand - Class in org.apache.commons.chain.generic
- LookupCommand() - Constructor for class org.apache.commons.chain.generic.LookupCommand
-
Create an instance, setting its
catalogFactory
property to the value ofCatalogFactory.getInstance()
. - LookupCommand(CatalogFactory) - Constructor for class org.apache.commons.chain.generic.LookupCommand
-
Create an instance and initialize the
catalogFactory
property to givenfactory
/
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.
- MapEntryImpl(Object, Object) - Constructor for class org.apache.commons.chain.impl.ContextBase.MapEntryImpl
- method - Variable in class org.apache.commons.chain.generic.DispatchCommand
-
Method name
- method - Variable in class org.apache.commons.chain.generic.DispatchLookupCommand
- methodKey - Variable in class org.apache.commons.chain.generic.DispatchCommand
-
Method key
- methodKey - Variable in class org.apache.commons.chain.generic.DispatchLookupCommand
- methods - Variable in class org.apache.commons.chain.generic.DispatchCommand
-
Cache of methods
- methods - Variable in class org.apache.commons.chain.generic.DispatchLookupCommand
- modifiable - Variable in class org.apache.commons.chain.web.MapEntry
-
Whether the entry can be modified.
N
- name - Variable in class org.apache.commons.chain.generic.LookupCommand
- nameAttribute - Variable in class org.apache.commons.chain.config.ConfigCatalogRule
-
The name of the attribute under which we can retrieve the name this catalog should be registered with (if any).
- nameAttribute - Variable in class org.apache.commons.chain.config.ConfigDefineRule
-
The name of the attribute under which we can retrieve the name this element for which rules should be created.
- nameAttribute - Variable in class org.apache.commons.chain.config.ConfigRegisterRule
-
The name of the attribute under which we can retrieve the name this command should be registered with.
- nameAttribute - Variable in class org.apache.commons.chain.config.ConfigRuleSet
- nameKey - Variable in class org.apache.commons.chain.generic.LookupCommand
- next() - Method in class org.apache.commons.chain.impl.ContextBase.EntrySetIterator
- next() - Method in class org.apache.commons.chain.impl.ContextBase.ValuesIterator
O
- optional - Variable in class org.apache.commons.chain.generic.LookupCommand
- 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 genericCommand
implementations useful across web application environments. - org.apache.commons.chain.web.portlet - package org.apache.commons.chain.web.portlet
-
Specialized
Context
andCommand
implementations suitable for use in a Portlet API environment. - org.apache.commons.chain.web.servlet - package org.apache.commons.chain.web.servlet
-
Specialized
Context
andCommand
implementations suitable for use in a Servlet API environment.
P
- param - Variable in class org.apache.commons.chain.web.portlet.PortletWebContext
-
The lazily instantiated
Map
of request parameter name-value. - param - Variable in class org.apache.commons.chain.web.servlet.ServletWebContext
-
The lazily instantiated
Map
of request parameter name-value. - parameter - Variable in class org.apache.commons.chain.web.servlet.RequestParameterMapper
- paramValues - Variable in class org.apache.commons.chain.web.portlet.PortletWebContext
-
The lazily instantiated
Map
of request parameter name-values. - paramValues - Variable in class org.apache.commons.chain.web.servlet.ServletWebContext
-
The lazily instantiated
Map
of request parameter name-values. - 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. - 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
- parseClassResources(String, ConfigParser) - Static method in class org.apache.commons.chain.web.ChainResources
-
Parse the specified class loader resources.
- parseClassResources(Catalog, String, ConfigParser) - Static method in class org.apache.commons.chain.web.ChainResources
-
Deprecated.Use the variant that does not take a catalog, on a configuration resource containing "catalog" element(s)
- parseJarResources(ServletContext, ConfigParser, Log) - Method in class org.apache.commons.chain.web.ChainListener
-
Parse resources found in JAR files in the
/WEB-INF/lib
subdirectory (if any). - parseJarResources(Catalog, ServletContext, ConfigParser, Log) - Method in class org.apache.commons.chain.web.ChainListener
-
Deprecated.Use the variant that does not take a catalog, on a configuration resource containing "catalog" element(s)
- parseWebResources(ServletContext, String, ConfigParser) - Static method in class org.apache.commons.chain.web.ChainResources
-
Parse the specified web application resources.
- parseWebResources(Catalog, ServletContext, String, ConfigParser) - Static method in class org.apache.commons.chain.web.ChainResources
-
Deprecated.Use the variant that does not take a catalog, on a configuration resource containing "catalog" element(s)
- PathInfoMapper - Class in org.apache.commons.chain.web.servlet
- PathInfoMapper() - Constructor for class org.apache.commons.chain.web.servlet.PathInfoMapper
- pd - Variable in class org.apache.commons.chain.impl.ContextBase
-
The same
PropertyDescriptor
s as an array. - PortletApplicationScopeMap - Class in org.apache.commons.chain.web.portlet
-
Private implementation of
Map
for portlet context attributes. - PortletApplicationScopeMap(PortletContext) - Constructor for class org.apache.commons.chain.web.portlet.PortletApplicationScopeMap
- 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
- PortletInitParamMap - Class in org.apache.commons.chain.web.portlet
-
Private implementation of
Map
for portlet context init parameters. - PortletInitParamMap(PortletContext) - Constructor for class org.apache.commons.chain.web.portlet.PortletInitParamMap
- PortletParamMap - Class in org.apache.commons.chain.web.portlet
-
Private implementation of
Map
for portlet parameter name-value. - PortletParamMap(PortletRequest) - Constructor for class org.apache.commons.chain.web.portlet.PortletParamMap
- PortletParamValuesMap - Class in org.apache.commons.chain.web.portlet
-
Private implementation of
Map
for portlet parameter name-values[]. - PortletParamValuesMap(PortletRequest) - Constructor for class org.apache.commons.chain.web.portlet.PortletParamValuesMap
- PortletRequestScopeMap - Class in org.apache.commons.chain.web.portlet
-
Private implementation of
Map
for portlet request attributes. - PortletRequestScopeMap(PortletRequest) - Constructor for class org.apache.commons.chain.web.portlet.PortletRequestScopeMap
- PortletSessionScopeMap - Class in org.apache.commons.chain.web.portlet
-
Private implementation of
Map
for portlet session attributes. - PortletSessionScopeMap(PortletRequest) - Constructor for class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- 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 thisFilter
instance. - postprocess(Context, Exception) - Method in class org.apache.commons.chain.generic.LookupCommand
- PROCESSING_COMPLETE - Static variable in interface org.apache.commons.chain.Command
-
Commands should return
PROCESSING_COMPLETE
if the processing of the givenContext
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. - put(Object, Object) - Method in class org.apache.commons.chain.web.portlet.PortletApplicationScopeMap
- put(Object, Object) - Method in class org.apache.commons.chain.web.portlet.PortletInitParamMap
- put(Object, Object) - Method in class org.apache.commons.chain.web.portlet.PortletParamMap
- put(Object, Object) - Method in class org.apache.commons.chain.web.portlet.PortletParamValuesMap
- put(Object, Object) - Method in class org.apache.commons.chain.web.portlet.PortletRequestScopeMap
- put(Object, Object) - Method in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- put(Object, Object) - Method in class org.apache.commons.chain.web.servlet.ServletApplicationScopeMap
- put(Object, Object) - Method in class org.apache.commons.chain.web.servlet.ServletCookieMap
- put(Object, Object) - Method in class org.apache.commons.chain.web.servlet.ServletHeaderMap
- put(Object, Object) - Method in class org.apache.commons.chain.web.servlet.ServletHeaderValuesMap
- put(Object, Object) - Method in class org.apache.commons.chain.web.servlet.ServletInitParamMap
- put(Object, Object) - Method in class org.apache.commons.chain.web.servlet.ServletParamMap
- put(Object, Object) - Method in class org.apache.commons.chain.web.servlet.ServletParamValuesMap
- put(Object, Object) - Method in class org.apache.commons.chain.web.servlet.ServletRequestScopeMap
- put(Object, Object) - Method in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
- putAll(Map) - Method in class org.apache.commons.chain.impl.ContextBase
-
Override the default
Map
behavior to call theput()
method individually for each key-value pair in the specifiedMap
. - putAll(Map) - Method in class org.apache.commons.chain.web.portlet.PortletApplicationScopeMap
- putAll(Map) - Method in class org.apache.commons.chain.web.portlet.PortletInitParamMap
- putAll(Map) - Method in class org.apache.commons.chain.web.portlet.PortletParamMap
- putAll(Map) - Method in class org.apache.commons.chain.web.portlet.PortletParamValuesMap
- putAll(Map) - Method in class org.apache.commons.chain.web.portlet.PortletRequestScopeMap
- putAll(Map) - Method in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- putAll(Map) - Method in class org.apache.commons.chain.web.servlet.ServletApplicationScopeMap
- putAll(Map) - Method in class org.apache.commons.chain.web.servlet.ServletCookieMap
- putAll(Map) - Method in class org.apache.commons.chain.web.servlet.ServletHeaderMap
- putAll(Map) - Method in class org.apache.commons.chain.web.servlet.ServletHeaderValuesMap
- putAll(Map) - Method in class org.apache.commons.chain.web.servlet.ServletInitParamMap
- putAll(Map) - Method in class org.apache.commons.chain.web.servlet.ServletParamMap
- putAll(Map) - Method in class org.apache.commons.chain.web.servlet.ServletParamValuesMap
- putAll(Map) - Method in class org.apache.commons.chain.web.servlet.ServletRequestScopeMap
- putAll(Map) - Method in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
R
- readProperty(PropertyDescriptor) - Method in class org.apache.commons.chain.impl.ContextBase
-
Get and return the value for the specified property.
- 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() - Method in class org.apache.commons.chain.impl.ContextBase.EntrySetIterator
- remove() - Method in class org.apache.commons.chain.impl.ContextBase.ValuesIterator
- remove(Object) - Method in class org.apache.commons.chain.impl.ContextBase.EntrySetImpl
- remove(Object) - Method in class org.apache.commons.chain.impl.ContextBase
-
Override the default
Map
behavior to throwUnsupportedOperationException
on any attempt to remove a key that is the name of a local property. - remove(Object) - Method in class org.apache.commons.chain.impl.ContextBase.ValuesImpl
- remove(Object) - Method in class org.apache.commons.chain.web.portlet.PortletApplicationScopeMap
- remove(Object) - Method in class org.apache.commons.chain.web.portlet.PortletInitParamMap
- remove(Object) - Method in class org.apache.commons.chain.web.portlet.PortletParamMap
- remove(Object) - Method in class org.apache.commons.chain.web.portlet.PortletParamValuesMap
- remove(Object) - Method in class org.apache.commons.chain.web.portlet.PortletRequestScopeMap
- remove(Object) - Method in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- remove(Object) - Method in class org.apache.commons.chain.web.servlet.ServletApplicationScopeMap
- remove(Object) - Method in class org.apache.commons.chain.web.servlet.ServletCookieMap
- remove(Object) - Method in class org.apache.commons.chain.web.servlet.ServletHeaderMap
- remove(Object) - Method in class org.apache.commons.chain.web.servlet.ServletHeaderValuesMap
- remove(Object) - Method in class org.apache.commons.chain.web.servlet.ServletInitParamMap
- remove(Object) - Method in class org.apache.commons.chain.web.servlet.ServletParamMap
- remove(Object) - Method in class org.apache.commons.chain.web.servlet.ServletParamValuesMap
- remove(Object) - Method in class org.apache.commons.chain.web.servlet.ServletRequestScopeMap
- remove(Object) - Method in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
- remove(Map.Entry) - Method in class org.apache.commons.chain.impl.ContextBase
-
Remove the specified key-value pair, if it exists, and return
true
. - 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.PortletParamMap
- request - Variable in class org.apache.commons.chain.web.portlet.PortletParamValuesMap
- request - Variable in class org.apache.commons.chain.web.portlet.PortletRequestScopeMap
- request - Variable in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- 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.ServletCookieMap
- request - Variable in class org.apache.commons.chain.web.servlet.ServletHeaderMap
- request - Variable in class org.apache.commons.chain.web.servlet.ServletHeaderValuesMap
- request - Variable in class org.apache.commons.chain.web.servlet.ServletParamMap
- request - Variable in class org.apache.commons.chain.web.servlet.ServletParamValuesMap
- request - Variable in class org.apache.commons.chain.web.servlet.ServletRequestScopeMap
- request - Variable in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
- 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
- RequestParameterMapper() - Constructor for class org.apache.commons.chain.web.servlet.RequestParameterMapper
- requestScope - Variable in class org.apache.commons.chain.web.portlet.PortletWebContext
-
The lazily instantiated
Map
of request scope attributes. - requestScope - Variable in class org.apache.commons.chain.web.servlet.ServletWebContext
-
The lazily instantiated
Map
of request scope attributes. - 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 ourConfigParser
. - 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 ourConfigParser
. - ruleSet - Variable in class org.apache.commons.chain.config.ConfigParser
-
The
RuleSet
to be used for configuring our Digester parsing rules.
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 theexecute()
method of the specifiedCommand
, loaded from our configuredCatalog
. - ServletApplicationScopeMap - Class in org.apache.commons.chain.web.servlet
-
Private implementation of
Map
for servlet context attributes. - ServletApplicationScopeMap(ServletContext) - Constructor for class org.apache.commons.chain.web.servlet.ServletApplicationScopeMap
- ServletCookieMap - Class in org.apache.commons.chain.web.servlet
-
Private implementation of
Map
for servlet cookies - ServletCookieMap(HttpServletRequest) - Constructor for class org.apache.commons.chain.web.servlet.ServletCookieMap
- 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
- ServletHeaderMap - Class in org.apache.commons.chain.web.servlet
-
Private implementation of
Map
for servlet request name-value. - ServletHeaderMap(HttpServletRequest) - Constructor for class org.apache.commons.chain.web.servlet.ServletHeaderMap
- ServletHeaderValuesMap - Class in org.apache.commons.chain.web.servlet
-
Private implementation of
Map
for servlet request name-values[]. - ServletHeaderValuesMap(HttpServletRequest) - Constructor for class org.apache.commons.chain.web.servlet.ServletHeaderValuesMap
- ServletInitParamMap - Class in org.apache.commons.chain.web.servlet
-
Private implementation of
Map
for servlet context init parameters. - ServletInitParamMap(ServletContext) - Constructor for class org.apache.commons.chain.web.servlet.ServletInitParamMap
- ServletParamMap - Class in org.apache.commons.chain.web.servlet
-
Private implementation of
Map
for servlet parameter name-value. - ServletParamMap(HttpServletRequest) - Constructor for class org.apache.commons.chain.web.servlet.ServletParamMap
- ServletParamValuesMap - Class in org.apache.commons.chain.web.servlet
-
Private implementation of
Map
for servlet parameter name-values[]. - ServletParamValuesMap(HttpServletRequest) - Constructor for class org.apache.commons.chain.web.servlet.ServletParamValuesMap
- ServletPathMapper - Class in org.apache.commons.chain.web.servlet
- ServletPathMapper() - Constructor for class org.apache.commons.chain.web.servlet.ServletPathMapper
- ServletRequestScopeMap - Class in org.apache.commons.chain.web.servlet
-
Private implementation of
Map
for servlet request attributes. - ServletRequestScopeMap(HttpServletRequest) - Constructor for class org.apache.commons.chain.web.servlet.ServletRequestScopeMap
- ServletSessionScopeMap - Class in org.apache.commons.chain.web.servlet
-
Private implementation of
Map
for HTTP session attributes. - ServletSessionScopeMap(HttpServletRequest) - Constructor for class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
- 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. - session - Variable in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- session - Variable in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
- sessionExists() - Method in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- sessionExists() - Method in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
- sessionScope - Variable in class org.apache.commons.chain.web.portlet.PortletWebContext
-
The lazily instantiated
Map
of session scope attributes. - sessionScope - Variable in class org.apache.commons.chain.web.servlet.ServletWebContext
-
The lazily instantiated
Map
of session scope attributes. - 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
- 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.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 ourDigester
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(Object) - Method in class org.apache.commons.chain.impl.ContextBase.MapEntryImpl
- setValue(Object) - Method in class org.apache.commons.chain.web.MapEntry
-
Sets the entry value if the entry can be modified.
- setValue(String) - Method in class org.apache.commons.chain.generic.CopyCommand
-
Set the literal value to be copied.
- singleton - Static variable in class org.apache.commons.chain.impl.ContextBase
-
Distinguished singleton value that is stored in the map for each key that is actually a property.
- size() - Method in class org.apache.commons.chain.impl.ContextBase.EntrySetImpl
- size() - Method in class org.apache.commons.chain.impl.ContextBase.ValuesImpl
- size() - Method in class org.apache.commons.chain.web.portlet.PortletApplicationScopeMap
- size() - Method in class org.apache.commons.chain.web.portlet.PortletInitParamMap
- size() - Method in class org.apache.commons.chain.web.portlet.PortletParamMap
- size() - Method in class org.apache.commons.chain.web.portlet.PortletParamValuesMap
- size() - Method in class org.apache.commons.chain.web.portlet.PortletRequestScopeMap
- size() - Method in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- size() - Method in class org.apache.commons.chain.web.servlet.ServletApplicationScopeMap
- size() - Method in class org.apache.commons.chain.web.servlet.ServletCookieMap
- size() - Method in class org.apache.commons.chain.web.servlet.ServletHeaderMap
- size() - Method in class org.apache.commons.chain.web.servlet.ServletHeaderValuesMap
- size() - Method in class org.apache.commons.chain.web.servlet.ServletInitParamMap
- size() - Method in class org.apache.commons.chain.web.servlet.ServletParamMap
- size() - Method in class org.apache.commons.chain.web.servlet.ServletParamValuesMap
- size() - Method in class org.apache.commons.chain.web.servlet.ServletRequestScopeMap
- size() - Method in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
T
- toKey - Variable in class org.apache.commons.chain.generic.CopyCommand
- toString() - Method in class org.apache.commons.chain.impl.CatalogBase
-
Converts this Catalog to a String.
- toString() - Method in class org.apache.commons.chain.impl.ContextBase.MapEntryImpl
- translate(String) - Method in class org.apache.commons.chain.web.ChainListener
-
Translate space character into
&pct;20
to avoid problems with paths that contain spaces on some JVMs.
U
- useContextClassLoader - Variable in class org.apache.commons.chain.config.ConfigParser
-
Should Digester use the context class loader?
V
- value - Variable in class org.apache.commons.chain.generic.CopyCommand
- value - Variable in class org.apache.commons.chain.impl.ContextBase.MapEntryImpl
- value - Variable in class org.apache.commons.chain.web.MapEntry
-
The entry value.
- values() - Method in class org.apache.commons.chain.impl.ContextBase
-
Override the default
Map
behavior to return aCollection
that meets the specified default behavior except for attempts to remove the key for a property of theContext
implementation class, which will throwUnsupportedOperationException
. - values() - Method in class org.apache.commons.chain.web.portlet.PortletApplicationScopeMap
- values() - Method in class org.apache.commons.chain.web.portlet.PortletInitParamMap
- values() - Method in class org.apache.commons.chain.web.portlet.PortletParamMap
- values() - Method in class org.apache.commons.chain.web.portlet.PortletParamValuesMap
- values() - Method in class org.apache.commons.chain.web.portlet.PortletRequestScopeMap
- values() - Method in class org.apache.commons.chain.web.portlet.PortletSessionScopeMap
- values() - Method in class org.apache.commons.chain.web.servlet.ServletApplicationScopeMap
- values() - Method in class org.apache.commons.chain.web.servlet.ServletCookieMap
- values() - Method in class org.apache.commons.chain.web.servlet.ServletHeaderMap
- values() - Method in class org.apache.commons.chain.web.servlet.ServletHeaderValuesMap
- values() - Method in class org.apache.commons.chain.web.servlet.ServletInitParamMap
- values() - Method in class org.apache.commons.chain.web.servlet.ServletParamMap
- values() - Method in class org.apache.commons.chain.web.servlet.ServletParamValuesMap
- values() - Method in class org.apache.commons.chain.web.servlet.ServletRequestScopeMap
- values() - Method in class org.apache.commons.chain.web.servlet.ServletSessionScopeMap
- ValuesImpl() - Constructor for class org.apache.commons.chain.impl.ContextBase.ValuesImpl
- valuesIterator() - Method in class org.apache.commons.chain.impl.ContextBase
-
Return an
Iterator
over the set of values in thisMap
. - ValuesIterator() - Constructor for class org.apache.commons.chain.impl.ContextBase.ValuesIterator
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
- writeProperty(PropertyDescriptor, Object) - Method in class org.apache.commons.chain.impl.ContextBase
-
Set the value for the specified property.
Z
- zeroParams - Static variable in class org.apache.commons.chain.impl.ContextBase
-
Zero-length array of parameter values for calling property getters.
All Classes All Packages