org.beyondcode.struts.dispatcher
Interface DispatcherMapping

All Known Implementing Classes:

DispatcherMappingImpl

public interface DispatcherMapping

This interface provides the additional methods that are needed by the Action classes in the dispatcher package. Any ActionMapping implementation which implements this interface can be used with the dispatcher package (specify the fully qualified name of the implementation class in the deployment descriptor web.xml as init-parameter to the servlet entry). It is not necessary to use or extend the mapping implementation provided with this package, since all other code only requires this interface.

This interface also provides safe accessors for the four "standard" forwards, namely those named "success", "failure", "denied", and "error".

Author:

Philipp K. Janert

Method Summary

org.apache.struts.action.ActionForward	denied() Get the 'access denied' ActionForward.
org.apache.struts.action.ActionForward	error() Get the 'error' ActionForward.
org.apache.struts.action.ActionForward	failure() Get the 'failure' ActionForward.
java.lang.String	getAccess() Get the access specification for this action mapping.
java.lang.String	getMethod() Get the name of the Action class' member function to dispatch to.
void	setAccess(java.lang.String access) Set the access specification for this action mapping.
void	setMethod(java.lang.String method) Set the name of the Action class' member function to dispatch to.
org.apache.struts.action.ActionForward	success() Get the 'success' ActionForward.

Method Detail

getMethod

public java.lang.String getMethod()

Get the name of the Action class' member function to dispatch to.

Returns:

The method name.

setMethod

public void setMethod(java.lang.String method)

Set the name of the Action class' member function to dispatch to.

Parameters:

method - The method name.

getAccess

public java.lang.String getAccess()

Get the access specification for this action mapping.

Returns:

The access information.

setAccess

public void setAccess(java.lang.String access)

Set the access specification for this action mapping.

Parameters:

access - The access information.

success

public org.apache.struts.action.ActionForward success()

Get the 'success' ActionForward.

Returns:

The 'success' ActionForward.

failure

public org.apache.struts.action.ActionForward failure()

Get the 'failure' ActionForward.

Returns:

The 'failure' ActionForward.

denied

public org.apache.struts.action.ActionForward denied()

Get the 'access denied' ActionForward.

Returns:

The 'access denied' ActionForward.

error

public org.apache.struts.action.ActionForward error()

Get the 'error' ActionForward.

Returns:

The 'error' ActionForward.