Package com.avoka.fc.core.service.composer

Class ComposerHtmlFormRenderService

java.lang.Object

com.avoka.fc.core.service.BaseService

com.avoka.fc.core.service.composer.ComposerHtmlFormRenderService

All Implemented Interfaces:

IComposerHtmlFormRenderService, IServiceDefinitionAware

public class ComposerHtmlFormRenderService
extends BaseService
implements IComposerHtmlFormRenderService, IServiceDefinitionAware

Provides a Composer HTML Form rendering service to render both the form and the associated HTML resources.

Field Summary

Fields inherited from interface com.avoka.fc.core.service.IComposerHtmlFormRenderService

INLINE, RENDER_MODES, RESOURCE_PATH, SEPARATE

Constructor Summary

Constructors

Constructor	Description
ComposerHtmlFormRenderService()

Method Summary

Modifier and Type	Method	Description
String	getAlwaysUse34RenderingMode()	Return the always used Composer 3.4 rendering mode flag.
Long	getBrowserResourceCachePeriod()	Return the browser resource caching period in seconds.
Double	getComposerFormVersion(HttpServletRequest request, Form form, TemplateVersion templateVersion)	Return the Composer Form version as major.minor version, e.g.
String	getComposerTiSupportJs()
Boolean	getCompressContent()	Return true if the service will GZIP compress the HTML content.
String	getCssRenderMode()	Gets the CSS render mode.
String	getImgRenderMode()	Gets the IMG render mode.
String	getJsRenderMode()	Gets the JS render mode.
String	getRenderFormTemplateType(HttpServletRequest request, Form form, TemplateVersion templateVersion)	Return the form template type [ 'desktop' | 'tablet' | 'phone' ] which will be rendered to the given request.
ServiceDefinition	getServiceDefinition()	Return the service definition for the service.
void	renderForm(TemplateVersion templateVersion, Form form, String xmlData, HttpServletRequest request, HttpServletResponse response, String targetUrl, RequestLog requestLog)	Render the Form using the given form, template version and XML data to the response.
boolean	renderResource(HttpServletRequest request, HttpServletResponse response)	Render the Form static resource to the given response.
void	setAlwaysUse34RenderingMode(String allwaysUse34RenderingMode)	Sets always used Composer 3.4 rendering mode flag.
void	setBrowserResourceCachePeriod(Long period)	Set the browser resource caching period in seconds.
void	setCacheMaximumSize(Integer cacheMaximumSize)	Sets the cache maximum size.
void	setCacheTimeOut(Integer cacheTimeOut)	Deprecated. this method does nothing
void	setComposerTiSupportJs(String composerTiSupportJs)
void	setCompressContent(Boolean compress)	Set whether to GZIP compress the HTML content.
void	setCssRenderMode(String cssRenderMode)	Sets the CSS render mode.
void	setImgRenderMode(String imgRenderMode)	Sets the IMG render mode.
void	setJsRenderMode(String jsRenderMode)	Sets the JS render mode.
void	setlocaleCachePeriod(int localeCachePeriod)	Set the locale JSON resources caching period in seconds.
void	setPerformanceTestingMaxHeaderSize(int maxHeaderSize)	Set performance testing max header size, where by the prefill data is rendered in the HTTP response header 'xml_data' only if the data size is less than this threshold.
void	setPerformanceTestingMode(boolean mode)	Set whether performance testing enabled, where by the prefill data is rendered in the HTTP response header 'xml_data'.
void	setReceiptRenderMode(boolean receiptMode)	Set whether in headless receipt render mode.
void	setServiceDefinition(ServiceDefinition serviceDefinition)	Set the service definition for the service.

Methods inherited from class com.avoka.fc.core.service.BaseService

getLogger

Methods inherited from class java.lang.Object

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

Constructor Detail

ComposerHtmlFormRenderService

public ComposerHtmlFormRenderService()

Method Detail

renderForm

public void renderForm(TemplateVersion templateVersion,
                       Form form,
                       String xmlData,
                       HttpServletRequest request,
                       HttpServletResponse response,
                       String targetUrl,
                       RequestLog requestLog)
                throws ApplicationException

Render the Form using the given form, template version and XML data to the response.

Specified by:

renderForm in interface IComposerHtmlFormRenderService

Parameters:

templateVersion - the form template version to render

form - the form to render

xmlData - the XML form data seed document

request - the users Http servlet request

response - the Http servlet response to render to

targetUrl - the target URL of the submission servlet

requestLog - optional request log parameter

Throws:

ApplicationException - if an error occurs at runtime

See Also:

IComposerHtmlFormRenderService.renderForm(TemplateVersion, Form, String, HttpServletRequest, HttpServletResponse, String, RequestLog)

renderResource

public boolean renderResource(HttpServletRequest request,
                              HttpServletResponse response)
                       throws IOException

Render the Form static resource to the given response.

Specified by:

renderResource in interface IComposerHtmlFormRenderService

Parameters:

request - the users Http servlet request

response - the Http servlet response to render to

Returns:

true, if successful

Throws:

IOException - if an error occurs rendering the resource

See Also:

IComposerHtmlFormRenderService.renderResource(HttpServletRequest, HttpServletResponse)

getRenderFormTemplateType

public String getRenderFormTemplateType(HttpServletRequest request,
                                        Form form,
                                        TemplateVersion templateVersion)

Return the form template type [ 'desktop' | 'tablet' | 'phone' ] which will be rendered to the given request.

Specified by:

getRenderFormTemplateType in interface IComposerHtmlFormRenderService

Parameters:

request - the form request

form - the form

templateVersion - the form template version

Returns:

the form template type [ 'desktop' | 'tablet' | 'phone' ]

See Also:

IComposerHtmlFormRenderService.getRenderFormTemplateType(HttpServletRequest, Form, TemplateVersion)

getComposerFormVersion

public Double getComposerFormVersion(HttpServletRequest request,
                                     Form form,
                                     TemplateVersion templateVersion)

Return the Composer Form version as major.minor version, e.g. 3.4.

Specified by:

getComposerFormVersion in interface IComposerHtmlFormRenderService

Parameters:

request - the form request

form - the form

templateVersion - the form template version

Returns:

the Composer Form version as major.minor version, e.g. 3.4.

Since:

3.6.0

See Also:

IComposerHtmlFormRenderService.getRenderFormTemplateType(HttpServletRequest, Form, TemplateVersion)

getBrowserResourceCachePeriod

public Long getBrowserResourceCachePeriod()

Return the browser resource caching period in seconds.

Specified by:

getBrowserResourceCachePeriod in interface IComposerHtmlFormRenderService

Returns:

the browser resource caching period in seconds

See Also:

IComposerHtmlFormRenderService.getBrowserResourceCachePeriod()

setBrowserResourceCachePeriod

public void setBrowserResourceCachePeriod(Long period)

Set the browser resource caching period in seconds.

Specified by:

setBrowserResourceCachePeriod in interface IComposerHtmlFormRenderService

Parameters:

period - the browser resource caching period in seconds

See Also:

IComposerHtmlFormRenderService.setBrowserResourceCachePeriod(Long)

getCompressContent

public Boolean getCompressContent()

Return true if the service will GZIP compress the HTML content.

Specified by:

getCompressContent in interface IComposerHtmlFormRenderService

Returns:

true if the service will GZIP compress the HTML content

See Also:

IComposerHtmlFormRenderService.getCompressContent()

setCompressContent

public void setCompressContent(Boolean compress)

Set whether to GZIP compress the HTML content.

Specified by:

setCompressContent in interface IComposerHtmlFormRenderService

Parameters:

compress - specify whether to GZIP compress the HTML content

See Also:

IComposerHtmlFormRenderService.setCompressContent(Boolean)

getJsRenderMode

public String getJsRenderMode()

Gets the JS render mode.

Specified by:

getJsRenderMode in interface IComposerHtmlFormRenderService

Returns:

the js render mode

See Also:

IComposerHtmlFormRenderService.getJsRenderMode()

setJsRenderMode

public void setJsRenderMode(String jsRenderMode)

Sets the JS render mode.

Specified by:

setJsRenderMode in interface IComposerHtmlFormRenderService

Parameters:

jsRenderMode - the new js render mode

See Also:

IComposerHtmlFormRenderService.setJsRenderMode(String)

getCssRenderMode

public String getCssRenderMode()

Gets the CSS render mode.

Specified by:

getCssRenderMode in interface IComposerHtmlFormRenderService

Returns:

the css render mode

See Also:

IComposerHtmlFormRenderService.getCssRenderMode()

setCssRenderMode

public void setCssRenderMode(String cssRenderMode)

Sets the CSS render mode.

Specified by:

setCssRenderMode in interface IComposerHtmlFormRenderService

Parameters:

cssRenderMode - the new css render mode

See Also:

IComposerHtmlFormRenderService.setCssRenderMode(String)

getImgRenderMode

public String getImgRenderMode()

Gets the IMG render mode.

Specified by:

getImgRenderMode in interface IComposerHtmlFormRenderService

Returns:

the IMG render mode

See Also:

IComposerHtmlFormRenderService.getImgRenderMode()

setImgRenderMode

public void setImgRenderMode(String imgRenderMode)

Sets the IMG render mode.

Specified by:

setImgRenderMode in interface IComposerHtmlFormRenderService

Parameters:

imgRenderMode - the new IMG render mode

See Also:

IComposerHtmlFormRenderService.setImgRenderMode(String)

setlocaleCachePeriod

public void setlocaleCachePeriod(int localeCachePeriod)

Set the locale JSON resources caching period in seconds.

Parameters:

localeCachePeriod - the locale JSON resources caching period in seconds.

Since:

5.1.0

getAlwaysUse34RenderingMode

public String getAlwaysUse34RenderingMode()

Return the always used Composer 3.4 rendering mode flag.

Specified by:

getAlwaysUse34RenderingMode in interface IComposerHtmlFormRenderService

Returns:

the always used Composer 3.4 rendering mode flag.

Since:

3.6.0

See Also:

IComposerHtmlFormRenderService.getAlwaysUse34RenderingMode()

setAlwaysUse34RenderingMode

public void setAlwaysUse34RenderingMode(String allwaysUse34RenderingMode)

Sets always used Composer 3.4 rendering mode flag.

Specified by:

setAlwaysUse34RenderingMode in interface IComposerHtmlFormRenderService

Parameters:

allwaysUse34RenderingMode - the new use old style rendering

Since:

3.6.0

See Also:

IComposerHtmlFormRenderService.setAlwaysUse34RenderingMode(String)

setReceiptRenderMode

public void setReceiptRenderMode(boolean receiptMode)

Set whether in headless receipt render mode.

Specified by:

setReceiptRenderMode in interface IComposerHtmlFormRenderService

Parameters:

receiptMode - set whether in headless receipt render mode.

Since:

4.0.0

See Also:

IComposerHtmlFormRenderService.setReceiptRenderMode(boolean)

getServiceDefinition

public ServiceDefinition getServiceDefinition()

Description copied from interface: IServiceDefinitionAware

Return the service definition for the service.

Specified by:

getServiceDefinition in interface IServiceDefinitionAware

Returns:

the service definition

Since:

18.11.0

See Also:

IServiceDefinitionAware.getServiceDefinition()

setServiceDefinition

public void setServiceDefinition(ServiceDefinition serviceDefinition)

Description copied from interface: IServiceDefinitionAware

Set the service definition for the service.

Specified by:

setServiceDefinition in interface IServiceDefinitionAware

Parameters:

serviceDefinition - the service definition to set

Since:

18.11.0

See Also:

IServiceDefinitionAware.setServiceDefinition(ServiceDefinition)

setPerformanceTestingMode

public void setPerformanceTestingMode(boolean mode)

Set whether performance testing enabled, where by the prefill data is rendered in the HTTP response header 'xml_data'.

Parameters:

mode - set whether in performance testing mode

setPerformanceTestingMaxHeaderSize

public void setPerformanceTestingMaxHeaderSize(int maxHeaderSize)

Set performance testing max header size, where by the prefill data is rendered in the HTTP response header 'xml_data' only if the data size is less than this threshold. Note Apache has a limit of 8k 8192 bytes for headers.

Parameters:

maxHeaderSize - the max header size in bytes.

Since:

20.5.0

setCacheTimeOut

public void setCacheTimeOut(Integer cacheTimeOut)

Deprecated.

this method does nothing

This method does nothing.

Parameters:

cacheTimeOut - the cacheTimeOut to set

Since:

4.0.1

setCacheMaximumSize

public void setCacheMaximumSize(Integer cacheMaximumSize)

Sets the cache maximum size.

Parameters:

cacheMaximumSize - the cache maximum size

Since:

4.0.2

getComposerTiSupportJs

public String getComposerTiSupportJs()

Returns:

the composerTiSupportJs

Since:

5.0.0

setComposerTiSupportJs

public void setComposerTiSupportJs(String composerTiSupportJs)

Parameters:

composerTiSupportJs - the composerTiSupportJs to set

Since:

5.0.0