com.ebay.lightning.client

Class LightningClientBuilder

java.lang.Object

com.ebay.lightning.client.LightningClientBuilder

public class LightningClientBuilder
extends Object

This is a builder class to create an instance of LightningClient with all required dependencies.

The default implementation of LightningClient returned submits task to one of the many stand alone instances of lightning core through Rest API. One or many lightning core instances has to be registered with the lightning client via setSeeds(List) method before calling the build() method.

 List<String> seeds = new ArrayList<String>();
 seeds.add("hostname1");
 seeds.add("hostname2");
 LightningClient client = new LightningClientBuilder()..addSeed("hostname1").setCorePort(8989).build();
 

The lightning core instance can be run in embedded mode by calling setEmbeddedMode(boolean) before invoking the build() method.

 LightningClient client = new LightningClientBuilder().setEmbeddedMode(true).build();
 

Author:

shashukla

See Also:

LightningClient

Constructor Summary

Constructors

Constructor and Description
LightningClientBuilder()

Method Summary

Modifier and Type	Method and Description
LightningClientBuilder	addSeed(String seed) Adds a single stand alone lightning core instances to the existing Seed List.
LightningClient	build() Creates an instance of LightningClient with all required dependencies.
LightningClientBuilder	setAllowCrossRegionInteraction(boolean allowCrossRegionInteraction) Set the lightning core to run in embedded mode.
LightningClientBuilder	setAuditApiUrlTemplate(String auditApiUrl) Set the API URL template for audit data.
LightningClientBuilder	setAuditJsonApiUrlTemplate(String auditJsonApiUrl) Set the API URL template for audit data in JSON format.
LightningClientBuilder	setAuditSummaryUrlTemplate(String auditSummaryUrl) Set the API URL template for audit summary data.
LightningClientBuilder	setCorePort(int corePort) Set the lightning core port.
LightningClientBuilder	setCrossRegionSeeds(List<String> crossRegionSeeds) Set the list of stand alone lightning core instances from different colocations.
LightningClientBuilder	setEmbeddedMode(boolean mode) Set the lightning core to run in embedded mode.
LightningClientBuilder	setLightningStatsUrlTemplate(String lightningStatsUrl) Set the API URL template to get lightning statistics.
LightningClientBuilder	setPollApiUrlTemplate(String pollApiUrl) Set the API URL template for polling response.
LightningClientBuilder	setReserveApiUrlTemplate(String reserveApiUrl) Set the API URL template for Reservation.
LightningClientBuilder	setSeeds(List<String> seeds) Set the list of stand alone lightning core instances.
LightningClientBuilder	setSubmitApiUrlTemplate(String submitApiUrl) Set the API URL template for submitting request.
LightningClientBuilder	setSystemConfigUpdateUrlTemplate(String systemConfigUpdateUrl) Set the API URL template to update system configuration.
LightningClientBuilder	setSystemConfigUrlTemplate(String systemConfigUrl) Set the API URL template to get system configuration.
LightningClientBuilder	setUrlUtils(com.ebay.lightning.core.utils.UrlUtils urlUtils) Set the UrlUtils

Methods inherited from class java.lang.Object

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

Constructor Detail

LightningClientBuilder

public LightningClientBuilder()

Method Detail

build

public LightningClient build()

Creates an instance of LightningClient with all required dependencies.

Returns:

the instance of LightningClient based on the configuration parameters before calling this method. REST API based LightningClient is returned if embeddedMode is set to false. An embedded LightningClient is returned if embeddedMode is set to true

setUrlUtils

public LightningClientBuilder setUrlUtils(com.ebay.lightning.core.utils.UrlUtils urlUtils)

Set the UrlUtils

Parameters:

urlUtils - the URL utils object to make http/https calls

Returns:

a reference to this object.

setPollApiUrlTemplate

public LightningClientBuilder setPollApiUrlTemplate(String pollApiUrl)

Set the API URL template for polling response.

Format: http://{hostname}:[port]/[some/poll/url]
Example: http://{host}:{port}/l/poll

Parameters:

pollApiUrl - the URL template for polling response

Returns:

a reference to this object.

setReserveApiUrlTemplate

public LightningClientBuilder setReserveApiUrlTemplate(String reserveApiUrl)

Set the API URL template for Reservation.

Format: http://{hostname}:[port]/[some/reservation/url]
Example: http://{host}:{port}/l/reserve

Parameters:

reserveApiUrl - the URL template for making reservation

Returns:

a reference to this object.

setSeeds

public LightningClientBuilder setSeeds(List<String> seeds)

Set the list of stand alone lightning core instances. The seeds are considered only when embeddedMode is set to false.

Parameters:

seeds - the list of host names running lightning core

Returns:

a reference to this object.

addSeed

public LightningClientBuilder addSeed(String seed)

Adds a single stand alone lightning core instances to the existing Seed List. The seeds are considered only when embeddedMode is set to false.

Parameters:

seed - name of running lightning core instance

Returns:

a reference to this object.

setCrossRegionSeeds

public LightningClientBuilder setCrossRegionSeeds(List<String> crossRegionSeeds)

Set the list of stand alone lightning core instances from different colocations. The cross region seeds are considered only when allowCrossRegionInteraction is set to true

Parameters:

crossRegionSeeds - the list of host names on different colocations running lightning core.

Returns:

a reference to this object.

setSubmitApiUrlTemplate

public LightningClientBuilder setSubmitApiUrlTemplate(String submitApiUrl)

Set the API URL template for submitting request.

Format: http://{hostname}:[port]/[some/submit/url]
Example: http://{host}:{port}/l/submit

Parameters:

submitApiUrl - the URL template for submitting tasks

Returns:

a reference to this object.

setAuditApiUrlTemplate

public LightningClientBuilder setAuditApiUrlTemplate(String auditApiUrl)

Set the API URL template for audit data.

Format: http://{hostname}:[port]/[some/audit/url]
Example: http://{host}:{port}/l/audit

Parameters:

auditApiUrl - the URL template to get compressed audit data

Returns:

a reference to this object.

setAuditJsonApiUrlTemplate

public LightningClientBuilder setAuditJsonApiUrlTemplate(String auditJsonApiUrl)

Set the API URL template for audit data in JSON format.

Format: http://{hostname}:[port]/[some/audit/url]
Example: http://{host}:{port}/l/audit/json

Parameters:

auditJsonApiUrl - the URL template to get audit data in JSON format

Returns:

a reference to this object.

setLightningStatsUrlTemplate

public LightningClientBuilder setLightningStatsUrlTemplate(String lightningStatsUrl)

Set the API URL template to get lightning statistics.

Format: http://{hostname}:[port]/[lightningStatsUrl]
Example: http://{host}:{port}/l/lightningStats

Parameters:

lightningStatsUrl - the URL template to get lightning statistics

Returns:

a reference to this object.

setAuditSummaryUrlTemplate

public LightningClientBuilder setAuditSummaryUrlTemplate(String auditSummaryUrl)

Set the API URL template for audit summary data.

Format: http://{hostname}:[port]/[some/auditSummary/url]
Example: http://{host}:{port}/l/auditSummary

Parameters:

auditSummaryUrl - the URL template to get audit summary data

Returns:

a reference to this object.

setSystemConfigUrlTemplate

public LightningClientBuilder setSystemConfigUrlTemplate(String systemConfigUrl)

Set the API URL template to get system configuration.

Format: http://{hostname}:[port]/[getSystemConfigUrl]
Example: http://{host}:{port}/l/getSystemConfig

Parameters:

systemConfigUrl - the URL template to get system configuration

Returns:

a reference to this object.

setSystemConfigUpdateUrlTemplate

public LightningClientBuilder setSystemConfigUpdateUrlTemplate(String systemConfigUpdateUrl)

Set the API URL template to update system configuration.

Format: http://{hostname}:[port]/[updateSystemConfigUrl]
Example: http://{host}:{port}/l/updateSystemConfig

Parameters:

systemConfigUpdateUrl - the URL template to update system configuration

Returns:

a reference to this object.

setEmbeddedMode

public LightningClientBuilder setEmbeddedMode(boolean mode)

Set the lightning core to run in embedded mode. If set to true, the lightning core will run in embedded mode. If set to false, lightning core will run in standalone mode and has to be registered with client by calling setSeeds(List) method.

Parameters:

mode - to run lightning core in embedded mode or standalone mode

Returns:

a reference to this object.

setAllowCrossRegionInteraction

public LightningClientBuilder setAllowCrossRegionInteraction(boolean allowCrossRegionInteraction)

Set the lightning core to run in embedded mode. If set to false, tasks will only be submitted to lightning core running on the same colocation. If set to true, tasks will be submitted to lightning core running on different colocation, if all the lightning core instances running in the local colocations are busy.

Parameters:

allowCrossRegionInteraction - to allow submitting task to lightning core running on different colocation

Returns:

a reference to this object.

setCorePort

public LightningClientBuilder setCorePort(int corePort)

Set the lightning core port. Please ensure that lightning core is running on this port before setting this.

Parameters:

corePort - port on which lightning core is running

Returns:

a reference to this object.