\r\n

51Degrees Pipeline Java  4.3Newer Version 4.4

51Degrees Pipeline for Java

fiftyone.pipeline.javascriptbuilder.flowelements.JavaScriptBuilderElement Class Reference

Detailed Description

[class]

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

Inheritance diagram for fiftyone.pipeline.javascriptbuilder.flowelements.JavaScriptBuilderElement:

[legend]

Collaboration diagram for fiftyone.pipeline.javascriptbuilder.flowelements.JavaScriptBuilderElement:

[legend]

Public Member Functions

 JavaScriptBuilderElement (Logger logger, ElementDataFactory< JavaScriptBuilderData > elementDataFactory, String endpoint, String objName, boolean enableCookies, String host, String protocol)
[constructor] More...
 JavaScriptBuilderElement (Logger logger, ElementDataFactory< JavaScriptBuilderData > elementDataFactory, String endpoint, String objName, boolean enableCookies, String host, String protocol, String contextRoot)
[constructor] More...
String  getElementDataKey ()
EvidenceKeyFilter  getEvidenceKeyFilter ()
List< ElementPropertyMetaData >  getProperties ()

Public Member Functions inherited from fiftyone.pipeline.core.flowelements.FlowElementBase< TData extends ElementData, TProperty extends ElementPropertyMetaData >

 FlowElementBase (Logger logger, ElementDataFactory< TData > elementDataFactory)
Construct a new instance of the FlowElement. More...
void  addPipeline (Pipeline pipeline)
List< Pipeline >  getPipelines ()
Get a unmodifiable list of the Pipelines that this element has been added to. More...
abstract String  getElementDataKey ()
abstract EvidenceKeyFilter  getEvidenceKeyFilter ()
abstract List< TProperty >  getProperties ()
TProperty  getProperty (String name)
TypedKey< TData >  getTypedDataKey ()
void  process (FlowData data) throws Exception
DataFactory< TData >  getDataFactory ()
boolean  isConcurrent ()
boolean  isClosed ()
void  close () throws Exception

Public Member Functions inherited from fiftyone.pipeline.core.flowelements.FlowElement< TData, TProperty >

void  process (FlowData data) throws Exception
Carry out whatever operations this element is designed to do using the FlowData passed. More...
void  addPipeline (Pipeline pipeline)
Called when this element is added to a pipeline. More...
EvidenceKeyFilter  getEvidenceKeyFilter ()
Get a filter that will only include the evidence keys that this element can make use of. More...
String  getElementDataKey ()
Get the string name of the key used to access the data populated by this element in the FlowData. More...
TypedKey< TData >  getTypedDataKey ()
Get the typed data key used for retrieving strongly typed element data. More...
List< TProperty >  getProperties ()
Get details of the properties that this element can populate. More...
TProperty  getProperty (String name)
Get a property from the properties that this element can populate using its name. More...
boolean  isConcurrent ()
if true, requires that the Pipeline guards against concurrent access to FlowData structures More...
boolean  isClosed ()
Indicates whether the element has been closed using the close() method, either explicitly or as a result of a 'try with resource'. More...
DataFactory< TData >  getDataFactory ()
Get the factory used to create the element data instances that are populated by this flow element. More...

Protected Member Functions

void  processInternal (FlowData data) throws Exception
[constructor]
void  managedResourcesCleanup ()
void  unmanagedResourcesCleanup ()

Protected Member Functions inherited from fiftyone.pipeline.core.flowelements.FlowElementBase< TData extends ElementData, TProperty extends ElementPropertyMetaData >

abstract void  processInternal (FlowData data) throws Exception
Abstract method to be overridden by a FlowElement author. More...
abstract void  managedResourcesCleanup ()
Cleanup any managed resources that the element is using.
abstract void  unmanagedResourcesCleanup ()
Cleanup any unmanaged resources that the element is using.
void  close (boolean closing)

Protected Attributes

String  host
String  endpoint
String  protocol
String  contextRoot
final String  objName
final boolean  enableCookies

Protected Attributes inherited from fiftyone.pipeline.core.flowelements.FlowElementBase< TData extends ElementData, TProperty extends ElementPropertyMetaData >

final Logger  logger
TypedKey< TData >  typedKey = null

Constructor & Destructor Documentation

◆ JavaScriptBuilderElement() [1/2]

fiftyone.pipeline.javascriptbuilder.flowelements.JavaScriptBuilderElement.JavaScriptBuilderElement ( Logger   logger,
ElementDataFactory< JavaScriptBuilderData >   elementDataFactory,
String   endpoint,
String   objName,
boolean   enableCookies,
String   host,
String   protocol  
)

[constructor]

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() [2/2]

fiftyone.pipeline.javascriptbuilder.flowelements.JavaScriptBuilderElement.JavaScriptBuilderElement ( Logger   logger,
ElementDataFactory< JavaScriptBuilderData >   elementDataFactory,
String   endpoint,
String   objName,
boolean   enableCookies,
String   host,
String   protocol,
String   contextRoot  
)

[constructor]

[constructor] 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.