com.ebay.lightning.client

Class LightningClient.LightningClientImpl

java.lang.Object

com.ebay.lightning.client.LightningClient.LightningClientImpl

All Implemented Interfaces:

LightningClient

Enclosing interface:

LightningClient

public static class LightningClient.LightningClientImpl
extends Object
implements LightningClient

LightningClientImpl is the one and only implementation of LightningClient as of version 1.0 This class is package protected to discourage direct instantiation. LightningClientBuild should be used to instantiate LightningClient

Author:

shashukla

Nested Class Summary

Nested classes/interfaces inherited from interface com.ebay.lightning.client.LightningClient

LightningClient.LightningClientImpl

Constructor Summary

Constructors

Constructor and Description
LightningClientImpl(LightningClientConfig config, ServiceHostResolver resolver, ServiceCaller caller)

Method Summary

Modifier and Type	Method and Description
protected void	addResponseCallback(com.ebay.lightning.core.beans.LightningRequest request, LightningResponseCallback callback, long timeoutInMillis) Register callback for request.
com.ebay.lightning.core.store.LightningRequestReport	getAuditJsonReport(String sessionId, String servingHostIp) Get the detailed execution report for the request in JSON format.
com.ebay.lightning.core.store.LightningRequestReport	getAuditReport(com.ebay.lightning.core.beans.LightningRequest req) Get the detailed execution report for the request in compressed format.
com.ebay.lightning.core.store.LightningRequestReport	getAuditReport(String sessionId, String servingHostIp) Get the detailed execution report for the request in compressed format.
List<com.ebay.lightning.core.store.LightningRequestReport>	getAuditSummary(String servingHostIp, String sessionId) Get all detailed execution report in compressed format.
LightningClientConfig	getConfig() Get the lighting client configuration.
com.ebay.lightning.core.beans.SystemStatus	getLightningStats(String servingHostIp) Get the lighting statistics.
com.ebay.lightning.core.config.SystemConfig	getSystemConfig(String servingHostIp) Get the system configuration parameters.
com.ebay.lightning.core.beans.LightningResponse	pollResponse(com.ebay.lightning.core.beans.LightningRequest req, boolean pollDeltaOnly) Poll the current result for request.
com.ebay.lightning.core.beans.LightningRequest	submit(List<com.ebay.lightning.core.beans.Task> tasks) Submit a list of tasks to be executed asynchronously at high speed.
com.ebay.lightning.core.beans.LightningRequest	submit(List<com.ebay.lightning.core.beans.Task> tasks, com.ebay.lightning.core.config.RequestConfig requestconfig) Submit a list of tasks to be executed asynchronously and configuration parameters.
void	submitWithCallback(List<com.ebay.lightning.core.beans.Task> tasks, LightningResponseCallback callback, long timeoutInMillis) Submit a list of tasks to be executed asynchronously at high speed.
void	submitWithCallback(List<com.ebay.lightning.core.beans.Task> tasks, com.ebay.lightning.core.config.RequestConfig requestconfig, LightningResponseCallback callback, long timeoutInMillis) Submit a list of tasks to be executed asynchronously and configuration parameters.
com.ebay.lightning.core.config.SystemConfig	updateSystemConfig(String servingHostIp, com.ebay.lightning.core.config.SystemConfig config) Update system configuration parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

LightningClientImpl

public LightningClientImpl(LightningClientConfig config,
                           ServiceHostResolver resolver,
                           ServiceCaller caller)

Method Detail

submit

public com.ebay.lightning.core.beans.LightningRequest submit(List<com.ebay.lightning.core.beans.Task> tasks)

Description copied from interface: LightningClient

Submit a list of tasks to be executed asynchronously at high speed.

Specified by:

submit in interface LightningClient

Parameters:

tasks - list of Task to be executed asynchronously

Returns:

LightningRequest that contain sessionId, ReservationReceipt etc

submit

public com.ebay.lightning.core.beans.LightningRequest submit(List<com.ebay.lightning.core.beans.Task> tasks,
                                                             com.ebay.lightning.core.config.RequestConfig requestconfig)

Description copied from interface: LightningClient

Submit a list of tasks to be executed asynchronously and configuration parameters.

Specified by:

submit in interface LightningClient

Parameters:

tasks - list of Task to be executed asynchronously

requestconfig - configuration parameters to execute the task

Returns:

LightningRequest that contain sessionId, ReservationReceipt etc

pollResponse

public com.ebay.lightning.core.beans.LightningResponse pollResponse(com.ebay.lightning.core.beans.LightningRequest req,
                                                                    boolean pollDeltaOnly)

Description copied from interface: LightningClient

Poll the current result for request. The method returns the complete or partial response based on the current state of the request.

Specified by:

pollResponse in interface LightningClient

Parameters:

req - the LightningRequest object returned by LightningClient.submit(List) method

pollDeltaOnly - get full or delta response

Returns:

LightningResponse that has the current state of task execution

submitWithCallback

public void submitWithCallback(List<com.ebay.lightning.core.beans.Task> tasks,
                               LightningResponseCallback callback,
                               long timeoutInMillis)

Description copied from interface: LightningClient

Submit a list of tasks to be executed asynchronously at high speed.

Specified by:

submitWithCallback in interface LightningClient

Parameters:

tasks - list of Task to be executed asynchronously

callback - LightningResponseCallback to invoke on completion of request or timeout.

timeoutInMillis - timeout for callback

submitWithCallback

public void submitWithCallback(List<com.ebay.lightning.core.beans.Task> tasks,
                               com.ebay.lightning.core.config.RequestConfig requestconfig,
                               LightningResponseCallback callback,
                               long timeoutInMillis)

Description copied from interface: LightningClient

Submit a list of tasks to be executed asynchronously and configuration parameters.

Specified by:

submitWithCallback in interface LightningClient

Parameters:

tasks - list of Task to be executed asynchronously

requestconfig - configuration parameters to execute the task

callback - LightningResponseCallback to invoke on completion of request or timeout.

timeoutInMillis - timeout for callback

addResponseCallback

protected void addResponseCallback(com.ebay.lightning.core.beans.LightningRequest request,
                                   LightningResponseCallback callback,
                                   long timeoutInMillis)

Register callback for request. Call this method to register on-complete and on-timeout callback.

Parameters:

request - the LightningRequest object returned by submit(List) method

callback - LightningResponseCallback to invoke on completion of request or timeout.

timeoutInMillis - timeout for callback

getAuditReport

public com.ebay.lightning.core.store.LightningRequestReport getAuditReport(com.ebay.lightning.core.beans.LightningRequest req)

Description copied from interface: LightningClient

Get the detailed execution report for the request in compressed format. This method is usually called after the complete execution of the request. The execution state of the method can be polled with LightningClient.pollResponse(LightningRequest, boolean) method.

Specified by:

getAuditReport in interface LightningClient

Parameters:

req - the LightningRequest object returned by LightningClient.submit(List) method

Returns:

LightningRequestReport that has the detailed execution report

getAuditReport

public com.ebay.lightning.core.store.LightningRequestReport getAuditReport(String sessionId,
                                                                           String servingHostIp)

Description copied from interface: LightningClient

Get the detailed execution report for the request in compressed format. This method is usually called after the complete execution of the request. The execution state of the method can be polled with LightningClient.pollResponse(LightningRequest, boolean) method.

Specified by:

getAuditReport in interface LightningClient

Parameters:

sessionId - the sessionId from LightningRequest

servingHostIp - the lightning core host that executed the task with the specific sessionId

Returns:

LightningRequestReport that has the detailed execution report in compressed format

getAuditJsonReport

public com.ebay.lightning.core.store.LightningRequestReport getAuditJsonReport(String sessionId,
                                                                               String servingHostIp)

Description copied from interface: LightningClient

Get the detailed execution report for the request in JSON format. This method is usually called after the complete execution of the request. The execution state of the method can be polled with LightningClient.pollResponse(LightningRequest, boolean) method.

Specified by:

getAuditJsonReport in interface LightningClient

Parameters:

sessionId - the sessionId from LightningRequest

servingHostIp - the lightning core host that executed the task with the specific sessionId

Returns:

LightningRequestReport that has the detailed execution report in JSON format

getAuditSummary

public List<com.ebay.lightning.core.store.LightningRequestReport> getAuditSummary(String servingHostIp,
                                                                                  String sessionId)

Description copied from interface: LightningClient

Get all detailed execution report in compressed format.

Specified by:

getAuditSummary in interface LightningClient

Parameters:

servingHostIp - the lightning core host for which audit summary need to be fetched

sessionId - the sessionId from LightningRequest

Returns:

list of LightningRequestReport that has the all detailed execution report in compressed format

updateSystemConfig

public com.ebay.lightning.core.config.SystemConfig updateSystemConfig(String servingHostIp,
                                                                      com.ebay.lightning.core.config.SystemConfig config)

Description copied from interface: LightningClient

Update system configuration parameters.

Specified by:

updateSystemConfig in interface LightningClient

Parameters:

servingHostIp - the lightning core instance that has to be updated

config - the new SystemConfig parameters

Returns:

the SystemConfig instance after update

getSystemConfig

public com.ebay.lightning.core.config.SystemConfig getSystemConfig(String servingHostIp)

Description copied from interface: LightningClient

Get the system configuration parameters.

Specified by:

getSystemConfig in interface LightningClient

Parameters:

servingHostIp - the lightning core instance for which the parameters has to be fetched

Returns:

the current SystemConfig instance of the host represented by servingHostIp

getLightningStats

public com.ebay.lightning.core.beans.SystemStatus getLightningStats(String servingHostIp)

Description copied from interface: LightningClient

Get the lighting statistics.

Specified by:

getLightningStats in interface LightningClient

Parameters:

servingHostIp - the lightning core instance for which lightning statistics has to be fetched

Returns:

the current SystemStatus instance of the host represented by servingHostIp

getConfig

public LightningClientConfig getConfig()

Description copied from interface: LightningClient

Get the lighting client configuration.

Specified by:

getConfig in interface LightningClient

Returns:

the lightning client configuration LightningClientConfig