Package | Description |
---|---|
org.apache.commons.chain |
The fundamental API contracts for the Chain of Responsibilty Pattern as
implemented in this 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 |
Convenient base implementations of Chain of Responsibility Pattern
contracts from
org.apache.commons.chain . |
org.apache.commons.chain.web |
Basis for specialized
Context implementations suitable for use
in web applications, and generic Command implementations useful
across web application environments. |
org.apache.commons.chain.web.portlet |
Specialized
Context and Command implementations
suitable for use in a Portlet API environment. |
org.apache.commons.chain.web.servlet |
Specialized
Context and Command implementations
suitable for use in a Servlet API environment. |
Modifier and Type | Method | Description |
---|---|---|
boolean |
Chain.execute(Context context) |
Execute the processing represented by this
Chain according
to the following algorithm. |
boolean |
Command.execute(Context context) |
Execute a unit of processing work to be performed.
|
boolean |
Filter.postprocess(Context context,
java.lang.Exception exception) |
Execute any cleanup activities, such as releasing resources that
were acquired during the
execute() method of this
Filter instance. |
Modifier and Type | Method | Description |
---|---|---|
boolean |
CopyCommand.execute(Context context) |
Copy a specified literal value, or a context attribute stored under
the
fromKey (if any), to the toKey . |
boolean |
DispatchCommand.execute(Context context) |
Look up the method specified by either "method" or "methodKey" and invoke it,
returning a boolean value as interpreted by
evaluateResult . |
boolean |
DispatchLookupCommand.execute(Context context) |
Look up the specified command, and (if found) execute it.
|
boolean |
LookupCommand.execute(Context context) |
Look up the specified command, and (if found) execute it.
|
boolean |
RemoveCommand.execute(Context context) |
Copy the specified source attribute to the specified destination
attribute.
|
protected java.lang.reflect.Method |
DispatchCommand.extractMethod(Context context) |
Extract the dispatch method.
|
private java.lang.reflect.Method |
DispatchLookupCommand.extractMethod(Command command,
Context context) |
Extract the dispatch method.
|
protected java.lang.Object[] |
DispatchCommand.getArguments(Context context) |
Get the arguments to be passed into the dispatch method.
|
protected java.lang.Object[] |
DispatchLookupCommand.getArguments(Context context) |
Get the arguments to be passed into the dispatch method.
|
protected Catalog |
LookupCommand.getCatalog(Context context) |
|
protected Command |
LookupCommand.getCommand(Context context) |
Return the
Command instance to be delegated to. |
protected java.lang.String |
LookupCommand.getCommandName(Context context) |
Return the name of the
Command instance to be delegated to. |
boolean |
LookupCommand.postprocess(Context context,
java.lang.Exception exception) |
Modifier and Type | Class | Description |
---|---|---|
class |
ContextBase |
Convenience base class for
Context implementations. |
Modifier and Type | Method | Description |
---|---|---|
boolean |
ChainBase.execute(Context context) |
See the
Chain JavaDoc. |
Modifier and Type | Class | Description |
---|---|---|
class |
WebContext |
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). |
Modifier and Type | Method | Description |
---|---|---|
boolean |
AbstractGetLocaleCommand.execute(Context context) |
Retrieve the
Locale for this request, and store it
under the specified context attribute. |
boolean |
AbstractSetLocaleCommand.execute(Context context) |
Retrieve the
Locale stored under the specified
context attribute key, and establish it on this response. |
protected abstract java.util.Locale |
AbstractGetLocaleCommand.getLocale(Context context) |
Retrieve and return the
Locale for this request. |
protected abstract void |
AbstractSetLocaleCommand.setLocale(Context context,
java.util.Locale locale) |
Establish the specified
Locale for this response. |
Modifier and Type | Class | Description |
---|---|---|
class |
PortletWebContext |
Concrete implementation of
WebContext suitable for use in
portlets. |
Modifier and Type | Method | Description |
---|---|---|
protected java.util.Locale |
PortletGetLocaleCommand.getLocale(Context context) |
Retrieve and return the
Locale for this request. |
protected void |
PortletSetLocaleCommand.setLocale(Context context,
java.util.Locale locale) |
Establish the specified
Locale for this response. |
Modifier and Type | Class | Description |
---|---|---|
class |
ServletWebContext |
Concrete implementation of
WebContext suitable for use in
Servlets and JSP pages. |
Modifier and Type | Method | Description |
---|---|---|
protected Catalog |
PathInfoMapper.getCatalog(Context context) |
|
protected Catalog |
RequestParameterMapper.getCatalog(Context context) |
|
protected Catalog |
ServletPathMapper.getCatalog(Context context) |
|
protected java.lang.String |
PathInfoMapper.getCommandName(Context context) |
Look up the extra path information for this request, and use it to
select an appropriate
Command to be executed. |
protected java.lang.String |
RequestParameterMapper.getCommandName(Context context) |
Look up the specified request paramater for this request, and use it
to select an appropriate
Command to be executed. |
protected java.lang.String |
ServletPathMapper.getCommandName(Context context) |
Look up the servlet path information for this request, and use it to
select an appropriate
Command to be executed. |
protected java.util.Locale |
ServletGetLocaleCommand.getLocale(Context context) |
Retrieve and return the
Locale for this request. |
protected void |
ServletSetLocaleCommand.setLocale(Context context,
java.util.Locale locale) |
Establish the specified
Locale for this response. |