Package fiftyone.pipeline.javascriptbuilder.flowelements

Class JavaScriptBuilderElement

java.lang.Object

fiftyone.pipeline.core.flowelements.FlowElementBase<JavaScriptBuilderData,fiftyone.pipeline.core.data.ElementPropertyMetaData>

fiftyone.pipeline.javascriptbuilder.flowelements.JavaScriptBuilderElement

All Implemented Interfaces:

fiftyone.pipeline.core.flowelements.FlowElement<JavaScriptBuilderData,fiftyone.pipeline.core.data.ElementPropertyMetaData>, AutoCloseable

public class JavaScriptBuilderElement
extends fiftyone.pipeline.core.flowelements.FlowElementBase<JavaScriptBuilderData,fiftyone.pipeline.core.data.ElementPropertyMetaData>

JavaScript Builder Element generates a JavaScript include to be run on the client device.

See Also:

Specification

Nested Class Summary

Nested classes/interfaces inherited from class fiftyone.pipeline.core.flowelements.FlowElementBase

fiftyone.pipeline.core.flowelements.FlowElementBase.DataFactoryInternal<T extends fiftyone.pipeline.core.data.ElementData>, fiftyone.pipeline.core.flowelements.FlowElementBase.DataFactorySimple<T extends fiftyone.pipeline.core.data.ElementData>

Nested classes/interfaces inherited from interface fiftyone.pipeline.core.flowelements.FlowElement

fiftyone.pipeline.core.flowelements.FlowElement.DataFactory<T extends fiftyone.pipeline.core.data.ElementData>

Field Summary

Fields

Modifier and Type	Field	Description
protected String	contextRoot
protected boolean	enableCookies
protected String	endpoint
protected String	host
protected String	objName
protected String	protocol

Fields inherited from class fiftyone.pipeline.core.flowelements.FlowElementBase

logger, typedKey

Constructor Summary

Constructors

Constructor	Description
JavaScriptBuilderElement(org.slf4j.Logger logger, fiftyone.pipeline.core.data.factories.ElementDataFactory<JavaScriptBuilderData> elementDataFactory, String endpoint, String objName, boolean enableCookies, String host, String protocol)	Default constructor.
JavaScriptBuilderElement(org.slf4j.Logger logger, fiftyone.pipeline.core.data.factories.ElementDataFactory<JavaScriptBuilderData> elementDataFactory, String endpoint, String objName, boolean enableCookies, String host, String protocol, String contextRoot)	Default constructor.

Method Summary

Modifier and Type	Method	Description
String	getElementDataKey()
fiftyone.pipeline.core.data.EvidenceKeyFilter	getEvidenceKeyFilter()
List<fiftyone.pipeline.core.data.ElementPropertyMetaData>	getProperties()
protected void	managedResourcesCleanup()
protected void	processInternal(fiftyone.pipeline.core.data.FlowData data)
protected void	unmanagedResourcesCleanup()

Methods inherited from class fiftyone.pipeline.core.flowelements.FlowElementBase

addPipeline, close, close, getDataFactory, getPipelines, getProperty, getTypedDataKey, isClosed, isConcurrent, process

Methods inherited from class java.lang.Object

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

Field Detail

host

protected String host

endpoint

protected String endpoint

protocol

protected String protocol

contextRoot

protected String contextRoot

objName

protected final String objName

enableCookies

protected final boolean enableCookies

Constructor Detail

JavaScriptBuilderElement

public JavaScriptBuilderElement(org.slf4j.Logger logger,
                                fiftyone.pipeline.core.data.factories.ElementDataFactory<JavaScriptBuilderData> elementDataFactory,
                                String endpoint,
                                String objName,
                                boolean enableCookies,
                                String host,
                                String protocol)

Default constructor.

Parameters:

logger - The logger.

elementDataFactory - The element data factory.

endpoint - Set the endpoint which will be queried on the host. e.g /api/v4/json

objName - The default name of the object instantiated by the client JavaScript.

enableCookies - Set whether the client JavaScript stored results of client side processing in cookies.

host - The host that the client JavaScript should query for updates. If null or blank then the host from the request will be used

protocol - The protocol (HTTP or HTTPS) that the client JavaScript will use when querying for updates. If null or blank then the protocol from the request will be used

JavaScriptBuilderElement

public JavaScriptBuilderElement(org.slf4j.Logger logger,
                                fiftyone.pipeline.core.data.factories.ElementDataFactory<JavaScriptBuilderData> elementDataFactory,
                                String endpoint,
                                String objName,
                                boolean enableCookies,
                                String host,
                                String protocol,
                                String contextRoot)

Default constructor.

Parameters:

logger - The logger.

elementDataFactory - The element data factory.

endpoint - Set the endpoint which will be queried on the host. e.g /api/v4/json

objName - The default name of the object instantiated by the client JavaScript.

enableCookies - Set whether the client JavaScript stored results of client side processing in cookies.

host - The host that the client JavaScript should query for updates. If null or blank then the host from the request will be used

protocol - The protocol (HTTP or HTTPS) that the client JavaScript will use when querying for updates. If null or blank then the protocol from the request will be used

contextRoot - The <context-root> setting from the web.xml. This is needed when creating the callback URL.

Method Detail

processInternal

protected void processInternal(fiftyone.pipeline.core.data.FlowData data)
                        throws Exception

Specified by:

processInternal in class fiftyone.pipeline.core.flowelements.FlowElementBase<JavaScriptBuilderData,fiftyone.pipeline.core.data.ElementPropertyMetaData>

Throws:

Exception

getElementDataKey

public String getElementDataKey()

Specified by:

getElementDataKey in interface fiftyone.pipeline.core.flowelements.FlowElement<JavaScriptBuilderData,fiftyone.pipeline.core.data.ElementPropertyMetaData>

Specified by:

getElementDataKey in class fiftyone.pipeline.core.flowelements.FlowElementBase<JavaScriptBuilderData,fiftyone.pipeline.core.data.ElementPropertyMetaData>

getEvidenceKeyFilter

public fiftyone.pipeline.core.data.EvidenceKeyFilter getEvidenceKeyFilter()

Specified by:

getEvidenceKeyFilter in interface fiftyone.pipeline.core.flowelements.FlowElement<JavaScriptBuilderData,fiftyone.pipeline.core.data.ElementPropertyMetaData>

Specified by:

getEvidenceKeyFilter in class fiftyone.pipeline.core.flowelements.FlowElementBase<JavaScriptBuilderData,fiftyone.pipeline.core.data.ElementPropertyMetaData>

getProperties

public List<fiftyone.pipeline.core.data.ElementPropertyMetaData> getProperties()

Specified by:

getProperties in interface fiftyone.pipeline.core.flowelements.FlowElement<JavaScriptBuilderData,fiftyone.pipeline.core.data.ElementPropertyMetaData>

Specified by:

getProperties in class fiftyone.pipeline.core.flowelements.FlowElementBase<JavaScriptBuilderData,fiftyone.pipeline.core.data.ElementPropertyMetaData>

managedResourcesCleanup

protected void managedResourcesCleanup()

Specified by:

managedResourcesCleanup in class fiftyone.pipeline.core.flowelements.FlowElementBase<JavaScriptBuilderData,fiftyone.pipeline.core.data.ElementPropertyMetaData>

unmanagedResourcesCleanup

protected void unmanagedResourcesCleanup()

Specified by:

unmanagedResourcesCleanup in class fiftyone.pipeline.core.flowelements.FlowElementBase<JavaScriptBuilderData,fiftyone.pipeline.core.data.ElementPropertyMetaData>