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>

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 and Description
protected boolean	enableCookies
protected String	endpoint
protected String	host
protected String	objName
protected boolean	overrideHost
protected boolean	overrideProtocol
protected String	protocol

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

logger, typedKey

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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, finalize, getDataFactory, getPipelines, getProperty, getTypedDataKey, isClosed, isConcurrent, process

Methods inherited from class java.lang.Object

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

Field Detail

host

protected String host

overrideHost

protected boolean overrideHost

endpoint

protected String endpoint

protocol

protected String protocol

overrideProtocol

protected boolean overrideProtocol

objName

protected String objName

enableCookies

protected boolean enableCookies

Constructor Detail

JavaScriptBuilderElement

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

Default constructor.

Parameters:

logger - The logger.

elementDataFactory - The element data factory.

host - The host that the client JavaScript should query for updates.

overrideHost - Set whether host should be determined from the origin or referer header.

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

protocol - The protocol (HTTP or HTTPS) that the client JavaScript will use when querying for updates.

overrideProtocol - Set whether the host should be overridden by evidence, e.g when the host can be determined from the incoming request.

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

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

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>