Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.apache.commons.chain.config.* (9)org.apache.commons.chain.generic.* (8)
org.apache.commons.chain.impl.* (17)org.apache.commons.chain.web.* (50)
org.apache.commons.chain.web.faces.* (3)org.apache.commons.chain.web.portlet.* (14)
org.apache.commons.chain.web.servlet.* (23)

org.apache.commons.chain: Javadoc index of package org.apache.commons.chain.


Package Samples:

org.apache.commons.chain.web.faces: Basis for specialized Context implementations suitable for use in web applications, and generic Command implementations useful across web application environments.  
org.apache.commons.chain.web.servlet: Basis for specialized Context implementations suitable for use in web applications, and generic Command implementations useful across web application environments.  
org.apache.commons.chain.impl: The fundamental API contracts for the Chain of Responsibilty Pattern as implemented in this package.  
org.apache.commons.chain.web: The fundamental API contracts for the Chain of Responsibilty Pattern as implemented in this package.  
org.apache.commons.chain.config
org.apache.commons.chain.generic
org.apache.commons.chain.web.portlet

Classes:

Command: 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 . Individual Command s can be assembled into a Chain , which allows them to either complete the required processing or delegate further processing to the next Command in the Chain . Command implementations should be designed in a thread-safe manner, suitable for inclusion in multiple Chain s that might be processed by different threads simultaneously. In general, this implies that Command classes should not maintain state information ...
ChainListener: ServletContextListener that automatically scans chain configuration files in the current web application at startup time, and exposes the result in a org.apache.commons.chain.Catalog under a specified servlet context attribute. The following context init parameters are utilized: org.apache.commons.chain.CONFIG_CLASS_RESOURCE - comma-delimited list of chain configuration resources to be loaded via ClassLoader.getResource() calls. If not specified, no class loader resources will be loaded. org.apache.commons.chain.CONFIG_WEB_RESOURCE - comma-delimited list of chain configuration webapp resources ...
ChainServlet: Servlet that automatically scans chain configuration files in the current web application at startup time, and exposes the result in a org.apache.commons.chain.Catalog under a specified servlet context attribute. The following servlet init parameters are utilized: org.apache.commons.chain.CONFIG_CLASS_RESOURCE - comma-delimited list of chain configuration resources to be loaded via ClassLoader.getResource() calls. If not specified, no class loader resources will be loaded. org.apache.commons.chain.CONFIG_WEB_RESOURCE - comma-delimited list of chain configuration webapp resources to be loaded. If ...
ConfigRuleSet: Digester RuleSet for configuring Chain of Responsibility command chains, and adding them to an appropriate org.apache.commons.chain.Catalog . The following properties may be configured prior to executing the addRuleInstance() method in order to influence the rules that get added, with default values in square brackets: catalogClass -- Fully qualified name of the implementation class used to create new org.apache.commons.chain.Catalog instances. If not specified, the default value is org.apache.commons.chain.impl.CatalogBsae . catalogElement -- Name of the XML element representing the addition of ...
Chain: A Chain represents a configured list of Command s that will be executed in order to perform processing on a specified Context . Each included Command will be executed in turn, until either one of them returns true , one of the executed Command s throws an exception, or the end of the chain has been reached. The Chain itself will return the return value of the last Command that was executed (if no exception was thrown), or rethrow the thrown exception. Note that Chain extends Command , so that the two can be used interchangeably when a Command is expected. This makes it easy to assemble workflows ...
Context: A Context represents the state information that is accessed and manipulated by the execution of a Command or a Chain . Specialized implementations of Context will typically add JavaBeans properties that contain typesafe accessors to information that is relevant to a particular use case for this context, and/or add operations that affect the state information that is saved in the context. Implementations of Context must also implement all of the required and optional contracts of the java.util.Map interface. It is strongly recommended, but not required, that JavaBeans properties added to a particular ...
Filter: 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. This promise must be fulfilled in spite of any possible exceptions thrown by the execute() method of this Command , or any subsequent Command whose execute() method was called. The owning Chain must call the postprocess() method of each Filter in a Chain in reverse order of the invocation of their execute() methods. The most common use case for a Filter , as opposed to a Command , is where potentially expensive resources must be acquired and held ...
ChainProcessor: Custom subclass of org.apache.commons.chain.web.ChainServlet that also dispatches incoming requests to a configurable org.apache.commons.chain.Command loaded from the specified org.apache.commons.chain.Catalog . In addition to the servlet init parameters supported by org.apache.commons.chain.web.ChainServlet , this class supports the following additional parameters: org.apache.commons.chain.CATALOG - Name of the catalog from which to acquire commands to be executed. If not specified, the default catalog for this application will be used. org.apache.commons.chain.COMMAND - Name of the org.apache.commons.chain.Command ...
DispatchLookupCommand: This command combines elements of the LookupCommand with the DispatchCommand . Look up a specified org.apache.commons.chain.Command (which could also be a org.apache.commons.chain.Chain ) in a org.apache.commons.chain.Catalog , and delegate execution to it. Introspection is used to lookup the appropriate method to delegate execution to. If the delegated-to org.apache.commons.chain.Command is also a org.apache.commons.chain.Filter , its postprocess() method will also be invoked at the appropriate time. The name of the org.apache.commons.chain.Command can be specified either directly (via the name ...
LookupCommand: Look up a specified org.apache.commons.chain.Command (which could also be a org.apache.commons.chain.Chain ) in a org.apache.commons.chain.Catalog , and delegate execution to it. If the delegated-to org.apache.commons.chain.Command is also a org.apache.commons.chain.Filter , its postprocess() method will also be invoked at the appropriate time. The name of the org.apache.commons.chain.Command can be specified either directly (via the name property) or indirectly (via the nameKey property). Exactly one of these must be set. If the optional property is set to true , failure to find the specified ...
WebContext: Abstract base implementation of org.apache.commons.chain.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). It is expected that a concrete subclass of WebContext for each API (such as org.apache.commons.chain.web.servlet.ServletWebContext ) will support adapting that particular API's implementation of request and response objects into this generic framework. The characteristics of a web request/response are made visible via a series of JavaBeans properties ...
ServletPathMapper: org.apache.commons.chain.Command that uses the "servlet path" component of the request URI to select a org.apache.commons.chain.Command from the appropriate org.apache.commons.chain.Catalog , and execute it. To use this command, you would typically map an instance of ChainProcessor to an extension pattern like "*.execute" and then arrange that this is the default command to be executed. In such an environment, a request for a context relative URI of "/foo.execute" would cause the "/foo.execute" command to be loaded and executed.
PathInfoMapper: org.apache.commons.chain.Command that uses the "path info" component of the request URI to select a org.apache.commons.chain.Command from the appropriate org.apache.commons.chain.Catalog , and execute it. To use this command, you would typically map an instance of ChainProcessor to a wildcard pattern like "/execute/*" and then arrange that this is the default command to be executed. In such an environment, a request for the context-relative URI "/execute/foo" would cause the "/foo" command to be loaded and executed.
RequestParameterMapper: org.apache.commons.chain.Command that uses a specified request parameter to select a org.apache.commons.chain.Command from the appropriate org.apache.commons.chain.Catalog , and execute it. To use this command, you would typically map an instance of ChainProcessor to a wildcard pattern like "*.execute" and then arrange that this is the default command to be executed. In such an environment, a request for the context-relative path "/foo.execute?command=bar" would cause the "/bar" command to be loaded and executed.
CatalogFactory: A CatalogFactory is a class used to store and retrieve Catalog s. The factory allows for a default Catalog as well as Catalog s stored with a name key. Follows the Factory pattern (see GoF). The base CatalogFactory implementation also implements a resolution mechanism which allows lookup of a command based on a single String which encodes both the catalog and command names.
ContextBase: Convenience base class for org.apache.commons.chain.Context implementations. In addition to the minimal functionality required by the org.apache.commons.chain.Context interface, this class implements the recommended support for Attribute-Property Transparency . This is implemented by analyzing the available JavaBeans properties of this class (or its subclass), exposes them as key-value pairs in the Map , with the key being the name of the property itself. IMPLEMENTATION NOTE - Because empty is a read-only property defined by the Map interface, it may not be utilized as an attribute key or property ...
ConfigCatalogRule: Digester rule that will cause the top-most element on the Digester stack (if it is a org.apache.commons.chain.Catalog to be registered with the org.apache.commons.chain.CatalogFactory instance for our application. If the attribute specified to our constructor has a value, that will be used as the name under which to register this org.apache.commons.chain.Catalog . Otherwise, this will become the default org.apache.commons.chain.Catalog for this application.
ConfigRegisterRule: Digester rule that will cause the top-most element on the Digester stack (if it is a org.apache.commons.chain.Command to be registered with the next-to-top element on the Digester stack (if it is a org.apache.commons.chain.Catalog or org.apache.commons.chain.Chain ). To be registered with a org.apache.commons.chain.Catalog , the top-most element must contain a value for the specified attribute that contains the name under which it should be registered.
Catalog: A Catalog is a collection of named Command s (or Chain s) that can be used retrieve the set of commands that should be performed based on a symbolic identifier. Use of catalogs is optional, but convenient when there are multiple possible chains that can be selected and executed based on environmental conditions.
ConfigParser: 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 org.apache.commons.chain.Catalog . Advanced users can configure the detailed parsing behavior by configuring the properties of an instance of this class prior to calling the parse() method. It is legal to call the parse() method more than once, in order to parse more than one configuration document.
AddingCommand: Implementation of org.apache.commons.chain.Command that logs its identifier and and attempts to add a new org.apache.commons.chain.Command to the org.apache.commons.chain.Chain . This should cause an IllegalStateException if the org.apache.commons.chain.Chain implementation subclasses ChainBase .
ConfigDefineRule: Digester rule that will dynamically register a new set of rules for a specified element name and default implementation class. This allows "alias" elements to be created for Chain and Command implementation classes that are commonly used. Besides factoring out the class names to make changes easier, this also makes configuration files much easier to read and write.
ServletWebContext: Concrete implementation of org.apache.commons.chain.web.WebContext suitable for use in Servlets and JSP pages. The abstract methods are mapped to the appropriate collections of the underlying servlet context, request, and response instances that are passed to the constructor (or the initialize method).
PortletWebContext: Concrete implementation of org.apache.commons.chain.web.WebContext suitable for use in portlets. The abstract methods are mapped to the appropriate collections of the underlying portlet context, request, and response instances that are passed to the constructor (or the initialize method).
AbstractGetLocaleCommand: Abstract base org.apache.commons.chain.Command implementation for retrieving the requested Locale from our org.apache.commons.chain.Context , and storing it under the context attribute key returned by the localeKey property.

Home | Contact Us | Privacy Policy | Terms of Service