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

java.lang.Object
  org.apache.commons.chain.web.servlet.ServletPathMapper

All Implemented Interfaces:

Command

public class ServletPathMapper

extends Object

implements Command

Command that uses the "servlet path" component of the request URI to select a Command from the appropriate 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.

Author:

Craig R. McClanahan

Constructor Summary

ServletPathMapper()

Method Summary

boolean	execute(Context context) Look up the servlet path information for this request, and use it to select an appropriate Command to be executed.
String	getCatalogKey() Return the context key under which our Catalog has been stored.
void	setCatalogKey(String catalogKey) Set the context key under which our Catalog has been stored.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServletPathMapper

public ServletPathMapper()

Method Detail

getCatalogKey

public String getCatalogKey()

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

setCatalogKey

public void setCatalogKey(String catalogKey)

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

Parameters:

catalogKey - The new catalog key

execute

public boolean execute(Context context)
                throws Exception

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

Specified by:

execute in interface Command

Parameters:

context - Context for the current request

Returns:

true if the processing of this Context has been completed, or false if the processing of this Context should be delegated to a subsequent Command in an enclosing Chain

Throws:

Exception - general purpose exception return to indicate abnormal termination