net.officefloor.plugin.web.http.route

Class HttpRouteTask

java.lang.Object

net.officefloor.frame.util.AbstractSingleTask<HttpRouteTask,HttpRouteTask.HttpRouteTaskDependencies,HttpRouteTask.HttpRouteTaskFlows>

net.officefloor.plugin.web.http.route.HttpRouteTask

All Implemented Interfaces:

OfficeAwareWorkFactory<HttpRouteTask>, TaskFactory<HttpRouteTask,HttpRouteTask.HttpRouteTaskDependencies,HttpRouteTask.HttpRouteTaskFlows>, WorkFactory<HttpRouteTask>, Task<HttpRouteTask,HttpRouteTask.HttpRouteTaskDependencies,HttpRouteTask.HttpRouteTaskFlows>, Work

public class HttpRouteTask
extends AbstractSingleTask<HttpRouteTask,HttpRouteTask.HttpRouteTaskDependencies,HttpRouteTask.HttpRouteTaskFlows>
implements OfficeAwareWorkFactory<HttpRouteTask>

Task for routing HttpRequest instances and ensuring appropriately secure ServerHttpConnection for servicing the HttpRequest.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpRouteTask.HttpRouteTaskDependencies Dependencies for the HttpRouteTask.
static class	HttpRouteTask.HttpRouteTaskFlows Flows for the HttpRouteTask.

Field Summary

Fields

Modifier and Type	Field and Description
static String	REDIRECT_URI_SUFFIX Suffix on the redirect HttpRequest URI to indicate a redirect has occurred.

Constructor Summary

Constructors

Constructor and Description
HttpRouteTask()

Method Summary

Modifier and Type	Method and Description
static void	doRedirect(String applicationUriPath, boolean isSecure, ServerHttpConnection connection, HttpApplicationLocation location, HttpRequestState requestState, HttpSession session) Undertakes a redirect.
Object	doTask(TaskContext<HttpRouteTask,HttpRouteTask.HttpRouteTaskDependencies,HttpRouteTask.HttpRouteTaskFlows> context) Does the task.
void	setOffice(Office office) Provides the WorkFactory its containing Office.

Methods inherited from class net.officefloor.frame.util.AbstractSingleTask

createTask, createWork, getRecycleManagedObjectParameter, registerAsRecycleTask, registerTask, registerTask, registerTask, registerWork

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.officefloor.frame.api.build.WorkFactory

createWork

Field Detail

REDIRECT_URI_SUFFIX

public static final String REDIRECT_URI_SUFFIX

Suffix on the redirect HttpRequest URI to indicate a redirect has occurred.

See Also:

Constant Field Values

Constructor Detail

HttpRouteTask

public HttpRouteTask()

Method Detail

doRedirect

public static void doRedirect(String applicationUriPath,
                              boolean isSecure,
                              ServerHttpConnection connection,
                              HttpApplicationLocation location,
                              HttpRequestState requestState,
                              HttpSession session)
                       throws IOException

Undertakes a redirect.

This may be utilised by any Task with a HttpUrlContinuationDifferentiator to trigger a redirect that will have the HttpRequest state appropriately managed across the redirect by the HttpRouteTask.

Parameters:

applicationUriPath - Application URI path.

isSecure - Whether a secure ServerHttpConnection is required.

connection - ServerHttpConnection.

location - HttpApplicationLocation.

requestState - HttpRequestState.

session - HttpSession.

Throws:

IOException - If unable to undertake redirect.

setOffice

public void setOffice(Office office)
               throws Exception

Description copied from interface: OfficeAwareWorkFactory

Provides the WorkFactory its containing Office.

Specified by:

setOffice in interface OfficeAwareWorkFactory<HttpRouteTask>

Parameters:

office - Office containing this WorkFactory.

Throws:

Exception - If fails to use the Office.

doTask

public Object doTask(TaskContext<HttpRouteTask,HttpRouteTask.HttpRouteTaskDependencies,HttpRouteTask.HttpRouteTaskFlows> context)
              throws InvalidHttpRequestUriException,
                     HttpRequestTokeniseException,
                     IOException,
                     UnknownWorkException,
                     UnknownTaskException,
                     InvalidParameterTypeException

Description copied from interface: Task

Does the task.

Specified by:

doTask in interface Task<HttpRouteTask,HttpRouteTask.HttpRouteTaskDependencies,HttpRouteTask.HttpRouteTaskFlows>

Parameters:

context - TaskContext for the Task.

Returns:

Parameter for the next Task. This allows stringing Task instances together into a JobSequence.

Throws:

InvalidHttpRequestUriException

HttpRequestTokeniseException

IOException

UnknownWorkException

UnknownTaskException

InvalidParameterTypeException