com.ebay.lightning.client

Interface LightningClient

All Known Implementing Classes:

LightningClient.LightningClientImpl

public interface LightningClient

LightningClient provides the interface for users to submit requests, poll response, see audit data etc to/from lightning core. Additionally, the interface provides functionality to read and update configuration at runtime.

Author:

shashukla

See Also:

LightningClient.LightningClientImpl

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	LightningClient.LightningClientImpl LightningClientImpl is the one and only implementation of LightningClient as of version 1.0 This class is package protected to discourage direct instantiation.

Method Summary

Modifier and Type	Method and Description
com.ebay.lightning.core.store.LightningRequestReport	getAuditJsonReport(java.lang.String sessionId, java.lang.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(java.lang.String sessionId, java.lang.String servingHostIp) Get the detailed execution report for the request in compressed format.
java.util.List<com.ebay.lightning.core.store.LightningRequestReport>	getAuditSummary(java.lang.String servingHostIp, java.lang.String sessionId) Get all detailed execution report in compressed format.
LightningClientConfig	getConfig() Get the lighting client configuration.
com.ebay.lightning.core.beans.SystemStatus	getLightningStats(java.lang.String servingHostIp) Get the lighting statistics.
com.ebay.lightning.core.config.SystemConfig	getSystemConfig(java.lang.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(java.util.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(java.util.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(java.util.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(java.util.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(java.lang.String servingHostIp, com.ebay.lightning.core.config.SystemConfig config) Update system configuration parameters.

Method Detail

submit

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

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

Parameters:

tasks - list of Task to be executed asynchronously

Returns:

LightningRequest that contain sessionId, ReservationReceipt etc

submit

com.ebay.lightning.core.beans.LightningRequest submit(java.util.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.

Parameters:

tasks - list of Task to be executed asynchronously

requestconfig - configuration parameters to execute the task

Returns:

LightningRequest that contain sessionId, ReservationReceipt etc

submitWithCallback

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

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

Parameters:

tasks - list of Task to be executed asynchronously

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

timeoutInMillis - timeout for callback

submitWithCallback

void submitWithCallback(java.util.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.

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

pollResponse

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

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

Parameters:

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

pollDeltaOnly - get full or delta response

Returns:

LightningResponse that has the current state of task execution

getAuditReport

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. This method is usually called after the complete execution of the request. The execution state of the method can be polled with pollResponse(LightningRequest, boolean) method.

Parameters:

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

Returns:

LightningRequestReport that has the detailed execution report

getAuditReport

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

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 pollResponse(LightningRequest, boolean) method.

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

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

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 pollResponse(LightningRequest, boolean) method.

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

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

Get all detailed execution report in compressed format.

Parameters:

sessionId - the sessionId from LightningRequest

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

Returns:

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

updateSystemConfig

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

Update system configuration parameters.

Parameters:

servingHostIp - the lightning core instance that has to be updated

config - the new SystemConfig parameters

Returns:

the SystemConfig instance after update

getSystemConfig

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

Get the system configuration parameters.

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

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

Get the lighting statistics.

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

LightningClientConfig getConfig()

Get the lighting client configuration.

Returns:

the lightning client configuration LightningClientConfig