info.rolandkrueger.roklib.webapps.urldispatching
Class AbstractURLActionHandler

java.lang.Object
  info.rolandkrueger.roklib.webapps.urldispatching.AbstractURLActionHandler

All Implemented Interfaces:

IURLActionHandler, Serializable

Direct Known Subclasses:

DispatchingURLActionHandler, SimpleURLActionHandler

public abstract class AbstractURLActionHandler
extends Object
implements IURLActionHandler

See Also:

Serialized Form

Nested Class Summary

private static class

AbstractURLActionHandler.CommandForCondition

Nested classes/interfaces inherited from interface info.rolandkrueger.roklib.webapps.urldispatching.IURLActionHandler

IURLActionHandler.ParameterMode

Field Summary

private static org.apache.log4j.Logger	LOG
private Map<String,List<Serializable>>	mActionArgumentMap
private List<String>	mActionArgumentOrder
protected String	mActionName
private String	mActionURI
private boolean	mCaseSensitive
private List<AbstractURLActionHandler.CommandForCondition>	mCommandsForCondition
private AbstractURLActionCommand	mDefaultCommand
protected List<IURLActionHandler>	mHandlerChain
private AbstractURLActionHandler	mParentHandler
private Map<String,AbstractURLActionHandler>	mSubHandlers
private List<IURLParameter<?>>	mURLParameters
private static long	serialVersionUID
private static String[]	STRING_ARRAY_PROTOTYPE

Constructor Summary

AbstractURLActionHandler(String actionName)

Method Summary

void	addActionArgument(String argumentName, Serializable... argumentValues) null argument values are ignored.
void	addDefaultCommandForCondition(AbstractURLActionCommand command, AbstractCondition condition)
void	addSubHandler(AbstractURLActionHandler subHandler)
void	addToHandlerChain(IURLActionHandler handler)
void	clearActionArguments()
void	clearDefaultCommands()
protected AbstractURLActionCommand	forwardToSubHandler(String handlerID, List<String> uriTokens, Map<String,List<String>> parameters, IURLActionHandler.ParameterMode parameterMode)
String	getActionName()
String	getActionURI()
void	getActionURLOverview(List<String> targetList)
protected IURLProvider	getContextURLProvider()
URL	getParameterizedActionURL(boolean clearAfterwards)
URL	getParameterizedActionURL(boolean clearAfterwards, IURLActionHandler.ParameterMode parameterMode)
URL	getParameterizedActionURL(boolean clearAfterwards, IURLActionHandler.ParameterMode parameterMode, boolean addHashMark)
URL	getParameterizedActionURL(boolean clearAfterwards, IURLActionHandler.ParameterMode parameterMode, boolean addHashMark, URL baseURL)
private Map<String,AbstractURLActionHandler>	getSubHandlerMap()
AbstractURLActionCommand	handleURL(List<String> pUriTokens, Map<String,List<String>> pParameters, IURLActionHandler.ParameterMode pParameterMode)
protected abstract AbstractURLActionCommand	handleURLImpl(List<String> uriTokens, Map<String,List<String>> parameters, IURLActionHandler.ParameterMode parameterMode)
protected boolean	haveRegisteredURLParametersErrors()
boolean	isCaseSensitive()
protected void	registerURLParameter(IURLParameter<?> parameter)
protected void	registerURLParameter(IURLParameter<?> parameter, boolean isOptional)
protected void	setCaseSensitive(boolean caseSensitive)
void	setDefaultActionCommand(AbstractURLActionCommand command)
protected void	setParent(AbstractURLActionHandler parent)
String	toString()
private String	urlEncode(String term)

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

STRING_ARRAY_PROTOTYPE

private static final String[] STRING_ARRAY_PROTOTYPE

LOG

private static final org.apache.log4j.Logger LOG

mCommandsForCondition

private List<AbstractURLActionHandler.CommandForCondition> mCommandsForCondition

mURLParameters

private List<IURLParameter<?>> mURLParameters

mActionArgumentOrder

private List<String> mActionArgumentOrder

mHandlerChain

protected List<IURLActionHandler> mHandlerChain

mSubHandlers

private Map<String,AbstractURLActionHandler> mSubHandlers

mActionArgumentMap

private Map<String,List<Serializable>> mActionArgumentMap

mParentHandler

private AbstractURLActionHandler mParentHandler

mDefaultCommand

private AbstractURLActionCommand mDefaultCommand

mActionName

protected String mActionName

mActionURI

private String mActionURI

mCaseSensitive

private boolean mCaseSensitive

Constructor Detail

AbstractURLActionHandler

public AbstractURLActionHandler(String actionName)

Method Detail

setCaseSensitive

protected void setCaseSensitive(boolean caseSensitive)

getSubHandlerMap

private Map<String,AbstractURLActionHandler> getSubHandlerMap()

isCaseSensitive

public boolean isCaseSensitive()

getActionName

public String getActionName()

setDefaultActionCommand

public void setDefaultActionCommand(AbstractURLActionCommand command)

registerURLParameter

protected void registerURLParameter(IURLParameter<?> parameter)

registerURLParameter

protected void registerURLParameter(IURLParameter<?> parameter,
                                    boolean isOptional)

haveRegisteredURLParametersErrors

protected boolean haveRegisteredURLParametersErrors()

handleURL

public final AbstractURLActionCommand handleURL(List<String> pUriTokens,
                                                Map<String,List<String>> pParameters,
                                                IURLActionHandler.ParameterMode pParameterMode)

Specified by:

handleURL in interface IURLActionHandler

handleURLImpl

protected abstract AbstractURLActionCommand handleURLImpl(List<String> uriTokens,
                                                          Map<String,List<String>> parameters,
                                                          IURLActionHandler.ParameterMode parameterMode)

urlEncode

private String urlEncode(String term)

addSubHandler

public final void addSubHandler(AbstractURLActionHandler subHandler)

getActionURI

public String getActionURI()

setParent

protected final void setParent(AbstractURLActionHandler parent)

getContextURLProvider

protected IURLProvider getContextURLProvider()

getParameterizedActionURL

public URL getParameterizedActionURL(boolean clearAfterwards)

getParameterizedActionURL

public URL getParameterizedActionURL(boolean clearAfterwards,
                                     IURLActionHandler.ParameterMode parameterMode)

getParameterizedActionURL

public URL getParameterizedActionURL(boolean clearAfterwards,
                                     IURLActionHandler.ParameterMode parameterMode,
                                     boolean addHashMark)

getParameterizedActionURL

public URL getParameterizedActionURL(boolean clearAfterwards,
                                     IURLActionHandler.ParameterMode parameterMode,
                                     boolean addHashMark,
                                     URL baseURL)

addDefaultCommandForCondition

public final void addDefaultCommandForCondition(AbstractURLActionCommand command,
                                                AbstractCondition condition)

addToHandlerChain

public void addToHandlerChain(IURLActionHandler handler)

addActionArgument

public void addActionArgument(String argumentName,
                              Serializable... argumentValues)

null argument values are ignored.

Parameters:

argumentName -

argumentValues -

clearActionArguments

public void clearActionArguments()

clearDefaultCommands

public final void clearDefaultCommands()

forwardToSubHandler

protected final AbstractURLActionCommand forwardToSubHandler(String handlerID,
                                                             List<String> uriTokens,
                                                             Map<String,List<String>> parameters,
                                                             IURLActionHandler.ParameterMode parameterMode)

getActionURLOverview

public void getActionURLOverview(List<String> targetList)

toString

public String toString()

Overrides:

toString in class Object