fiftyone.pipeline.javascriptbuilder.flowelements

Class JavaScriptBuilderElementBuilder

java.lang.Object

fiftyone.pipeline.javascriptbuilder.flowelements.JavaScriptBuilderElementBuilder

public class JavaScriptBuilderElementBuilder
extends Object

Builder for the @see JavaScriptBuilderElement

Field Summary

Fields

Modifier and Type	Field and Description
protected String	endpoint
protected String	host
protected String	objName
protected boolean	overrideHost
protected boolean	overrideProtocol
protected String	protocol

Constructor Summary

Constructors

Constructor and Description
JavaScriptBuilderElementBuilder(org.slf4j.ILoggerFactory loggerFactory)

Method Summary

Modifier and Type	Method and Description
JavaScriptBuilderElement	build() Build the @see JavaScriptBuilderElement
JavaScriptBuilderElementBuilder	setDefaultProtocol(String protocol) The default protocol that the client JavaScript will use when querying for updates.
JavaScriptBuilderElementBuilder	setEnableCookies(boolean enableCookies) Set whether the client JavaScript stores results of client side processing in cookies.
JavaScriptBuilderElementBuilder	setEndpoint(String endpoint) Set the endpoint which will be queried on the host.
JavaScriptBuilderElementBuilder	setHost(String host) Set the host that the client JavaScript should query for updates.
JavaScriptBuilderElementBuilder	setObjectName(String objName) The default name of the object instantiated by the client JavaScript.
JavaScriptBuilderElementBuilder	setOverrideDefaultProtocol(boolean overrideProto) Set whether the host should be overridden by evidence, e.g when the host can be determined from the incoming request.
JavaScriptBuilderElementBuilder	setOverrideHost(boolean overrideHost) Set whether host should be determined from the origin or referer header.

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

Constructor Detail

JavaScriptBuilderElementBuilder

public JavaScriptBuilderElementBuilder(org.slf4j.ILoggerFactory loggerFactory)

Method Detail

setHost

public JavaScriptBuilderElementBuilder setHost(String host)

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

Parameters:

host - the hostname.

Returns:

JavaScriptBuilderElementBuilder

setOverrideHost

public JavaScriptBuilderElementBuilder setOverrideHost(boolean overrideHost)

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

Parameters:

overrideHost - Should override host?

Returns:

JavaScriptBuilderElementBuilder

setEndpoint

public JavaScriptBuilderElementBuilder setEndpoint(String endpoint)

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

Parameters:

endpoint - The endpoint.

Returns:

JavaScriptBuilderElementBuilder

setDefaultProtocol

public JavaScriptBuilderElementBuilder setDefaultProtocol(String protocol)

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

Parameters:

protocol - The protocol to use (http / https)

Returns:

JavaScriptBuilderElementBuilder

setOverrideDefaultProtocol

public JavaScriptBuilderElementBuilder setOverrideDefaultProtocol(boolean overrideProto)

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

Parameters:

overrideProto - Should override the protocol?

Returns:

JavaScriptBuilderElementBuilder

setObjectName

public JavaScriptBuilderElementBuilder setObjectName(String objName)

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

Parameters:

objName - The object name to use.

Returns:

JavaScriptBuilderElementBuilder

setEnableCookies

public JavaScriptBuilderElementBuilder setEnableCookies(boolean enableCookies)

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

Parameters:

enableCookies - Should enable cookies?

Returns:

JavaScriptBuilderElementBuilder

build

public JavaScriptBuilderElement build()

Build the @see JavaScriptBuilderElement

Returns:

JavaScriptBuilderElement