\r\n

51Degrees Pipeline Java  4.4

51Degrees Pipeline for Java

fiftyone.pipeline.javascriptbuilder.flowelements.JavaScriptBuilderElementBuilder Class Reference

Detailed Description

[class]

Builder for the JavaScriptBuilderElement

Public Member Functions

 JavaScriptBuilderElementBuilder (ILoggerFactory loggerFactory)
Construct a new instance. More...
JavaScriptBuilderElementBuilder  setHost (String host)
Set the host that the client JavaScript should query for updates. More...
JavaScriptBuilderElementBuilder  setEndpoint (String endpoint)
Set the endpoint which will be queried on the host. More...
JavaScriptBuilderElementBuilder  setContextRoot (String contextRoot)
Set the evidence value for the context root. More...
JavaScriptBuilderElementBuilder  setProtocol (String protocol)
The protocol that the client JavaScript will use when querying for updates. More...
JavaScriptBuilderElementBuilder  setObjectName (String objName)
The default name of the object instantiated by the client JavaScript. More...
JavaScriptBuilderElementBuilder  setEnableCookies (boolean enableCookies)
Set whether the client JavaScript stores results of client side processing in cookies. More...
JavaScriptBuilderElement  build ()
Build the JavaScriptBuilderElement. More...

Static Public Attributes

static final boolean  ENABLE_COOKIES = true

Protected Attributes

String  host = ""
String  endpoint = ""
String  protocol = ""
String  contextRoot = ""
String  objName = ""

Constructor & Destructor Documentation

◆ JavaScriptBuilderElementBuilder()

fiftyone.pipeline.javascriptbuilder.flowelements.JavaScriptBuilderElementBuilder.JavaScriptBuilderElementBuilder ( ILoggerFactory   loggerFactory )

Construct a new instance.

Parameters
loggerFactory - the ILoggerFactory to use when creating loggers for the element

Member Function Documentation

◆ build()

JavaScriptBuilderElement fiftyone.pipeline.javascriptbuilder.flowelements.JavaScriptBuilderElementBuilder.build ( )

Build the JavaScriptBuilderElement.

Returns
new JavaScriptBuilderElement instance

◆ setContextRoot()

JavaScriptBuilderElementBuilder fiftyone.pipeline.javascriptbuilder.flowelements.JavaScriptBuilderElementBuilder.setContextRoot ( String   contextRoot )

Set the evidence value for the context root.

Default is value from evidence "server.contextroot"

Parameters
contextRoot -
Returns
this builder

◆ setEnableCookies()

JavaScriptBuilderElementBuilder fiftyone.pipeline.javascriptbuilder.flowelements.JavaScriptBuilderElementBuilder.setEnableCookies ( boolean   enableCookies )

Set whether the client JavaScript stores results of client side processing in cookies.

If set to false, the JavaScript will not populate any cookies, and will instead use session storage.

This can also be set per request, using the "query.fod-js-enable-cookies" evidence key. For more details on personal data policy, see http://51degrees.com/terms/client-services-privacy-policy/

Default is true

Parameters
enableCookies - should enable cookies?
Returns
this builder

◆ setEndpoint()

JavaScriptBuilderElementBuilder fiftyone.pipeline.javascriptbuilder.flowelements.JavaScriptBuilderElementBuilder.setEndpoint ( String   endpoint )

Set the endpoint which will be queried on the host.

e.g /api/v4/json

By default, this value is an empty string

Parameters
endpoint - the endpoint
Returns
this builder

◆ setHost()

JavaScriptBuilderElementBuilder fiftyone.pipeline.javascriptbuilder.flowelements.JavaScriptBuilderElementBuilder.setHost ( String   host )

Set the host that the client JavaScript should query for updates.

By default, the host from the request will be used.

Parameters
host - the hostname
Returns
this builder

◆ setObjectName()

JavaScriptBuilderElementBuilder fiftyone.pipeline.javascriptbuilder.flowelements.JavaScriptBuilderElementBuilder.setObjectName ( String   objName )

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

Default is "fod"

Parameters
objName - the object name to use
Returns
this builder

◆ setProtocol()

JavaScriptBuilderElementBuilder fiftyone.pipeline.javascriptbuilder.flowelements.JavaScriptBuilderElementBuilder.setProtocol ( String   protocol )

The protocol that the client JavaScript will use when querying for updates.

By default, the protocol from the request will be used.

Parameters
protocol - The protocol to use (http / https)
Returns
this builder
On This Page

Generated by doxygen 1.8.15