net.officefloor.plugin.web.http.template

Class HttpTemplateWorkSource

java.lang.Object

net.officefloor.compile.spi.work.source.impl.AbstractWorkSource<HttpTemplateWork>

net.officefloor.plugin.web.http.template.HttpTemplateWorkSource

All Implemented Interfaces:

WorkSource<HttpTemplateWork>, WorkSourceService<HttpTemplateWork,HttpTemplateWorkSource>

public class HttpTemplateWorkSource
extends AbstractWorkSource<HttpTemplateWork>
implements WorkSourceService<HttpTemplateWork,HttpTemplateWorkSource>

WorkSource for the HTTP template.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested classes/interfaces inherited from class net.officefloor.compile.spi.work.source.impl.AbstractWorkSource

AbstractWorkSource.SpecificationContext

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_CHARSET Property to specify the Charset for outputting the template.
static String	PROPERTY_LINK_SECURE_PREFIX Property prefix to obtain whether a specific link requires a secure ServerHttpConnection.
static String	PROPERTY_TEMPLATE_CONTENT Property to obtain the raw HttpTemplate content.
static String	PROPERTY_TEMPLATE_FILE Property to specify the HttpTemplate file.
static String	PROPERTY_TEMPLATE_FILE_CHARSET Property to specify the Charset for reading in the template.
static String	PROPERTY_TEMPLATE_SECURE Property to indicate if the HttpTemplate requires a secure ServerHttpConnection.
static String	PROPERTY_TEMPLATE_URI Property to obtain the HttpTemplate URI path.
static String	PROPERTY_TEMPLATE_URI_SUFFIX Property to obtain the HttpTemplate URI suffix on the template URI path and various link URI paths.

Constructor Summary

Constructors

Constructor and Description
HttpTemplateWorkSource()

Method Summary

Modifier and Type	Method and Description
static net.officefloor.plugin.web.http.template.parse.HttpTemplate	getHttpTemplate(Reader templateContent) Obtains the HttpTemplate.
static net.officefloor.plugin.web.http.template.parse.HttpTemplate	getHttpTemplate(SourceContext context) Obtains the HttpTemplate.
static Reader	getHttpTemplateContent(SourceContext context) Obtains the raw HttpTemplate content.
static String[]	getHttpTemplateLinkNames(net.officefloor.plugin.web.http.template.parse.HttpTemplate template) Obtains the link names for the HttpTemplate.
static String	getHttpTemplateLinkUrlContinuationPath(String templateUriPath, String linkName, String templateUriSuffix) Obtains the HttpTemplate link URL continuation path.
static String	getHttpTemplateUrlContinuationPath(SourceProperties properties) Obtains the HttpTemplate URL continuation path.
String	getWorkSourceAlias() Obtains the alias for the WorkSource Class.
Class<HttpTemplateWorkSource>	getWorkSourceClass() Obtains the WorkSource Class.
static boolean	isHttpTemplateSectionRequireBean(net.officefloor.plugin.web.http.template.parse.HttpTemplateSection section) Determines if the HttpTemplateSection requires a bean.
static boolean	isHttpTemplateSecure(SourceProperties properties) Determines if the HttpTemplate is secure.
protected void	loadSpecification(AbstractWorkSource.SpecificationContext context) Loads the WorkSourceSpecification.
void	sourceWork(WorkTypeBuilder<HttpTemplateWork> workTypeBuilder, WorkSourceContext context) Sources the WorkType by populating it via the input WorkTypeBuilder.

Methods inherited from class net.officefloor.compile.spi.work.source.impl.AbstractWorkSource

getSpecification

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_TEMPLATE_FILE

public static final String PROPERTY_TEMPLATE_FILE

Property to specify the HttpTemplate file.

See Also:

Constant Field Values

PROPERTY_TEMPLATE_CONTENT

public static final String PROPERTY_TEMPLATE_CONTENT

Property to obtain the raw HttpTemplate content. This is tried if there is no template path.

See Also:

Constant Field Values

PROPERTY_TEMPLATE_URI

public static final String PROPERTY_TEMPLATE_URI

Property to obtain the HttpTemplate URI path.

See Also:

Constant Field Values

PROPERTY_TEMPLATE_URI_SUFFIX

public static final String PROPERTY_TEMPLATE_URI_SUFFIX

Property to obtain the HttpTemplate URI suffix on the template URI path and various link URI paths.

See Also:

Constant Field Values

PROPERTY_TEMPLATE_SECURE

public static final String PROPERTY_TEMPLATE_SECURE

Property to indicate if the HttpTemplate requires a secure ServerHttpConnection.

See Also:

Constant Field Values

PROPERTY_TEMPLATE_FILE_CHARSET

public static final String PROPERTY_TEMPLATE_FILE_CHARSET

Property to specify the Charset for reading in the template.

See Also:

Constant Field Values

PROPERTY_LINK_SECURE_PREFIX

public static final String PROPERTY_LINK_SECURE_PREFIX

Property prefix to obtain whether a specific link requires a secure ServerHttpConnection.

See Also:

Constant Field Values

PROPERTY_CHARSET

public static final String PROPERTY_CHARSET

Property to specify the Charset for outputting the template.

See Also:

Constant Field Values

PROPERTY_BEAN_PREFIX

public static final String PROPERTY_BEAN_PREFIX

Property prefix to obtain the bean for the HttpTemplateSection.

See Also:

Constant Field Values

Constructor Detail

HttpTemplateWorkSource

public HttpTemplateWorkSource()

Method Detail

getHttpTemplate

public static net.officefloor.plugin.web.http.template.parse.HttpTemplate getHttpTemplate(SourceContext context)
                                                                                   throws IOException

Obtains the HttpTemplate.

Parameters:

context - SourceContext providing details about the HttpTemplate.

Returns:

HttpTemplate.

Throws:

IOException - If fails to obtain the HttpTemplate.

getHttpTemplateContent

public static Reader getHttpTemplateContent(SourceContext context)
                                     throws IOException

Obtains the raw HttpTemplate content.

Parameters:

context - SourceContext providing details about the HttpTemplate.

Returns:

Raw HttpTemplate content.

Throws:

IOException - If fails to obtain the raw HttpTemplate content.

getHttpTemplate

public static net.officefloor.plugin.web.http.template.parse.HttpTemplate getHttpTemplate(Reader templateContent)
                                                                                   throws IOException

Obtains the HttpTemplate.

Parameters:

templateContent - Raw HttpTemplate content.

Returns:

HttpTemplate.

Throws:

IOException - If fails to obtain the HttpTemplate.

isHttpTemplateSectionRequireBean

public static boolean isHttpTemplateSectionRequireBean(net.officefloor.plugin.web.http.template.parse.HttpTemplateSection section)

Determines if the HttpTemplateSection requires a bean.

Parameters:

section - HttpTemplateSection.

Returns:

true if the HttpTemplateSection requires a bean.

getHttpTemplateUrlContinuationPath

public static String getHttpTemplateUrlContinuationPath(SourceProperties properties)
                                                 throws InvalidHttpRequestUriException

Obtains the HttpTemplate URL continuation path.

Parameters:

properties - SourceProperties.

Returns:

URL continuation path for the HttpTemplate.

Throws:

InvalidHttpRequestUriException - Should the configured HttpTemplate path be invalid.

getHttpTemplateLinkUrlContinuationPath

public static String getHttpTemplateLinkUrlContinuationPath(String templateUriPath,
                                                            String linkName,
                                                            String templateUriSuffix)
                                                     throws InvalidHttpRequestUriException

Obtains the HttpTemplate link URL continuation path.

Parameters:

templateUriPath - HttpTemplate URI path.

linkName - Name of the link.

templateUriSuffix - HttpTemplate URI suffix. May be null for no suffix.

Returns:

HttpTemplate link URI path.

Throws:

InvalidHttpRequestUriException - Should the resulting URI be invalid.

isHttpTemplateSecure

public static boolean isHttpTemplateSecure(SourceProperties properties)

Determines if the HttpTemplate is secure.

Parameters:

properties - SourceProperties.

Returns:

true should the HttpTemplate be secure.

getHttpTemplateLinkNames

public static String[] getHttpTemplateLinkNames(net.officefloor.plugin.web.http.template.parse.HttpTemplate template)

Obtains the link names for the HttpTemplate.

Parameters:

template - HttpTemplate.

Returns:

Link names.

getWorkSourceAlias

public String getWorkSourceAlias()

Description copied from interface: WorkSourceService

Obtains the alias for the WorkSource Class.

Specified by:

getWorkSourceAlias in interface WorkSourceService<HttpTemplateWork,HttpTemplateWorkSource>

Returns:

Alias for the WorkSource Class.

getWorkSourceClass

public Class<HttpTemplateWorkSource> getWorkSourceClass()

Description copied from interface: WorkSourceService

Obtains the WorkSource Class.

Specified by:

getWorkSourceClass in interface WorkSourceService<HttpTemplateWork,HttpTemplateWorkSource>

Returns:

WorkSource Class.

loadSpecification

protected void loadSpecification(AbstractWorkSource.SpecificationContext context)

Description copied from class: AbstractWorkSource

Loads the WorkSourceSpecification.

Specified by:

loadSpecification in class AbstractWorkSource<HttpTemplateWork>

Parameters:

context - AbstractWorkSource.SpecificationContext.

sourceWork

public void sourceWork(WorkTypeBuilder<HttpTemplateWork> workTypeBuilder,
                       WorkSourceContext context)
                throws Exception

Description copied from interface: WorkSource

Sources the WorkType by populating it via the input WorkTypeBuilder.

Specified by:

sourceWork in interface WorkSource<HttpTemplateWork>

Parameters:

workTypeBuilder - WorkTypeBuilder to be populated with the type definition of the Work.

context - WorkSourceContext to source details to populate the WorkTypeBuilder.

Throws:

Exception - If fails to populate the WorkTypeBuilder.