net.officefloor.plugin.servlet.container

Interface ServletRequestForwarder

All Known Implementing Classes:

HttpServletRequestImpl

public interface ServletRequestForwarder

Made available by the HttpServletContainer within the ServletRequest.getAttribute(String).

This allows the implementation of RequestDispatcher for the ServletContext. It is also available to HttpServlet implementations managed within the HttpServletContainer to utilise OfficeFloor capabilities.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_FORWARDER Name of attribute in the ServletRequest containing this ServletRequestForwarder.

Method Summary

Modifier and Type	Method and Description
void	forward(String workName, String taskName, Object parameter) Forwards the ServletRequest.

Field Detail

ATTRIBUTE_FORWARDER

static final String ATTRIBUTE_FORWARDER

Name of attribute in the ServletRequest containing this ServletRequestForwarder.

See Also:

Constant Field Values

Method Detail

forward

void forward(String workName,
             String taskName,
             Object parameter)
      throws javax.servlet.ServletException

Forwards the ServletRequest.

Parameters:

workName - Name of Work to forward the ServletRequest.

taskName - Name of Task on the Work to forward the ServletRequest.

parameter - Parameter for the Task.

Throws:

javax.servlet.ServletException - If fails to forward the ServletRequest.