Index

A C D E F G I K L O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

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

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

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

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

addCommand(CMD) - 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(CMD) - Method in class org.apache.commons.chain.impl.ChainBase

See the Chain JavaDoc.

addCommand(String, CMD) - 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(String, CMD) - 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.

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<C> - 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_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<C> - 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<String, Command<C>>) - Constructor for class org.apache.commons.chain.impl.CatalogBase

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

CatalogFactory<C> - 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

The Default-Constructor for this class.

CatalogFactoryBase<C> - 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<C> - 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<C> - 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(Collection<Command<C>>) - Constructor for class org.apache.commons.chain.impl.ChainBase

Construct a Chain configured with the specified Commands.

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

Construct a Chain configured with the specified Command.

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

Construct a Chain configured with the specified Commands.

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<C> - 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.

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

The Default-Constructor for this class.

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

The Default-Constructor for this class.

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.

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<String, Object>) - Constructor for class org.apache.commons.chain.impl.ContextBase

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

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<C> - 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

The Default-Constructor for this class.

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.

DispatchCommand<C> - 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

The Default-Constructor for this class.

DispatchLookupCommand<C> - 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<C>) - 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.

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

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

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

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

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

Execute a unit of processing work to be performed.

execute(C) - 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(C) - 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(C) - Method in class org.apache.commons.chain.generic.DispatchLookupCommand

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

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

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

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

Copy the specified source attribute to the specified destination attribute.

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

See the Chain JavaDoc.

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

Extract the dispatch method.

F

Filter<C> - 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.

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.

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

Get the arguments to be passed into the dispatch method.

getArguments(C) - 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(C) - Method in class org.apache.commons.chain.generic.LookupCommand

Return the Catalog to look up the Command in.

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.

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.

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(C) - Method in class org.apache.commons.chain.generic.LookupCommand

Return the Command instance to be delegated to.

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(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(C) - Method in class org.apache.commons.chain.generic.LookupCommand

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

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.

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

Return the singleton CatalogFactory instance for the relevant ClassLoader.

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.

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.

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.

I

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).

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

Returns true, if the configuration of our commands list has been frozen by a call to the execute() method, false otherwise.

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<C> - 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<C>) - Constructor for class org.apache.commons.chain.generic.LookupCommand

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

O

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

The fundamental API contracts for the Chain of Responsibility 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.

P

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

postprocess(C, 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(C, 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(String, 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<? extends String, ? extends Object>) - 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

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<C> - 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

The Default-Constructor for this class.

S

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

Sets the default instance of Catalog associated with the factory.

setCatalog(Catalog<C>) - 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<C>) - Method in class org.apache.commons.chain.generic.LookupCommand

Set the CatalogFactory from which lookups will be performed.

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.

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.

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.

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.

A C D E F G I K L O P R S T V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form