net.officefloor.plugin.web.http.template

Class HttpTemplateTask

java.lang.Object

net.officefloor.frame.util.AbstractSingleTask<HttpTemplateWork,Indexed,None>

net.officefloor.plugin.web.http.template.HttpTemplateTask

All Implemented Interfaces:

TaskFactory<HttpTemplateWork,Indexed,None>, WorkFactory<HttpTemplateWork>, Task<HttpTemplateWork,Indexed,None>, Work

public class HttpTemplateTask
extends AbstractSingleTask<HttpTemplateWork,Indexed,None>

Task to write the HttpTemplateSection.

Author:

Daniel Sagenschneider

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTY_BEAN_PREFIX Property prefix to obtain the bean for the HttpTemplateSection.
static String	PROPERTY_LINK_SECURE_PREFIX Property prefix to obtain whether the link is to be secure.

Constructor Summary

Constructors

Constructor and Description
HttpTemplateTask(HttpTemplateWriter[] contentWriters, boolean isBean, Charset charset) Initiate.

Method Summary

Modifier and Type	Method and Description
Object	doTask(TaskContext<HttpTemplateWork,Indexed,None> context) Does the task.
static boolean	isLinkSecure(String linkName, boolean isTemplateSecure, SourceProperties properties) Determines if the link should be secure.
static String[]	loadTaskType(net.officefloor.plugin.web.http.template.parse.HttpTemplateSection section, Charset charset, String templateUriPath, String templateUriSuffix, boolean isTemplateSecure, WorkTypeBuilder<HttpTemplateWork> workTypeBuilder, WorkSourceContext context) Loads the TaskType to write the HttpTemplateSection.

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

PROPERTY_BEAN_PREFIX

public static final String PROPERTY_BEAN_PREFIX

Property prefix to obtain the bean for the HttpTemplateSection.

See Also:

Constant Field Values

PROPERTY_LINK_SECURE_PREFIX

public static final String PROPERTY_LINK_SECURE_PREFIX

Property prefix to obtain whether the link is to be secure.

See Also:

Constant Field Values

Constructor Detail

HttpTemplateTask

public HttpTemplateTask(HttpTemplateWriter[] contentWriters,
                        boolean isBean,
                        Charset charset)

Initiate.

Parameters:

contentWriters - HttpTemplateWriter instances to write the content.

isBean - Flag indicating if a bean.

charset - Default Charset for the template.

Method Detail

loadTaskType

public static String[] loadTaskType(net.officefloor.plugin.web.http.template.parse.HttpTemplateSection section,
                                    Charset charset,
                                    String templateUriPath,
                                    String templateUriSuffix,
                                    boolean isTemplateSecure,
                                    WorkTypeBuilder<HttpTemplateWork> workTypeBuilder,
                                    WorkSourceContext context)
                             throws Exception

Loads the TaskType to write the HttpTemplateSection.

Parameters:

section - HttpTemplateSection.

charset - Charset for the template.

templateUriPath - URI path for the HttpTemplate.

templateUriSuffix - URI suffix for the HttpTemplate link URI paths. May be null for no suffix.

isTemplateSecure - Indicates if the template is to be secure.

workTypeBuilder - WorkTypeBuilder.

context - WorkSourceContext.

Returns:

Listing of Task names to handle HttpTemplate link requests.

Throws:

Exception - If fails to prepare the template.

isLinkSecure

public static boolean isLinkSecure(String linkName,
                                   boolean isTemplateSecure,
                                   SourceProperties properties)

Determines if the link should be secure.

Parameters:

linkName - Name of link.

isTemplateSecure - Indicates whether the HttpTemplate is secure.

properties - SourceProperties.

Returns:

true should the link be secure.

doTask

public Object doTask(TaskContext<HttpTemplateWork,Indexed,None> 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