net.officefloor.plugin.web.http.template.section

Class HttpTemplateInitialTask

java.lang.Object

net.officefloor.frame.util.AbstractSingleTask<HttpTemplateInitialTask,HttpTemplateInitialTask.Dependencies,HttpTemplateInitialTask.Flows>

net.officefloor.plugin.web.http.template.section.HttpTemplateInitialTask

All Implemented Interfaces:

TaskFactory<HttpTemplateInitialTask,HttpTemplateInitialTask.Dependencies,HttpTemplateInitialTask.Flows>, WorkFactory<HttpTemplateInitialTask>, Task<HttpTemplateInitialTask,HttpTemplateInitialTask.Dependencies,HttpTemplateInitialTask.Flows>, Work

public class HttpTemplateInitialTask
extends AbstractSingleTask<HttpTemplateInitialTask,HttpTemplateInitialTask.Dependencies,HttpTemplateInitialTask.Flows>

Initial Task to ensure appropriate conditions for rendering the HttpTemplate.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpTemplateInitialTask.Dependencies Keys for the HttpTemplateInitialTask dependencies.
static class	HttpTemplateInitialTask.Flows Keys for the HttpTemplateInitialTask flows.

Field Summary

Fields

Modifier and Type	Field and Description
static String[]	DEFAULT_RENDER_REDIRECT_HTTP_METHODS Default HTTP methods to redirect before rendering the HttpTemplate.

Constructor Summary

Constructors

Constructor and Description
HttpTemplateInitialTask(String templateUriPath, boolean isRequireSecure, String[] renderRedirectHttpMethods, String contentType, Charset charset) Initiate.

Method Summary

Modifier and Type	Method and Description
Object	doTask(TaskContext<HttpTemplateInitialTask,HttpTemplateInitialTask.Dependencies,HttpTemplateInitialTask.Flows> context) Does the task.

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

Field Detail

DEFAULT_RENDER_REDIRECT_HTTP_METHODS

public static final String[] DEFAULT_RENDER_REDIRECT_HTTP_METHODS

Default HTTP methods to redirect before rendering the HttpTemplate.

Constructor Detail

HttpTemplateInitialTask

public HttpTemplateInitialTask(String templateUriPath,
                               boolean isRequireSecure,
                               String[] renderRedirectHttpMethods,
                               String contentType,
                               Charset charset)

Initiate.

Parameters:

templateUriPath - URI path for the HttpTemplate.

isRequireSecure - Indicates if a secure ServerHttpConnection is required.

renderRedirectHttpMethods - Listing of HTTP methods that require a redirect before rendering the HttpTemplate.

contentType - Content-type for the HttpTemplate. May be null.

charset - Charset for HttpTemplate.

Method Detail

doTask

public Object doTask(TaskContext<HttpTemplateInitialTask,HttpTemplateInitialTask.Dependencies,HttpTemplateInitialTask.Flows> context)
              throws IOException

Description copied from interface: Task

Does the task.

Parameters:

context - TaskContext for the Task.

Returns:

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

Throws:

IOException