com.ebay.lightning.client.caller

Interface ServiceCaller

All Known Implementing Classes:

EmbeddedAPICaller, RestAPICaller

public interface ServiceCaller

ServiceCaller acts as a interface between the client and core (aka seeds). This interface provides the methods to make reservation, submit tasks, poll the task response, get audit data, view/edit configuration etc.

Author:

shashukla

See Also:

RestAPICaller, EmbeddedAPICaller

Method Summary

Modifier and Type	Method and Description
com.ebay.lightning.core.store.LightningRequestReport	getAuditJsonReport(String sessionId, String serviceHostIp) Get the audit report for the request id in JSON format.
com.ebay.lightning.core.store.LightningRequestReport	getAuditReport(String sessionId, String serviceHostIp) Get the audit report for the request id in compressed format.
List<com.ebay.lightning.core.store.LightningRequestReport>	getAuditSummary(String serviceHostIp, String sessionId) Get the audit summary in compressed format.
com.ebay.lightning.core.beans.SystemStatus	getLightningStats(String servingHostIp) Get the system statistics of the seed
com.ebay.lightning.core.config.SystemConfig	getSystemConfig(String serviceHostIp) Get the configuration of the seed
com.ebay.lightning.core.beans.LightningResponse	pollResults(String sessionId, String serviceHostIp, boolean pollDeltaOnly) Get the result for the session id.
com.ebay.lightning.core.beans.ReservationReceipt	reserve(int count, String serviceHostIp) Attempts to reserve task execution bandwidth on the seed
boolean	submit(com.ebay.lightning.core.beans.LightningRequest request, String serviceHostIp) Submits the request to the specific seed.
com.ebay.lightning.core.config.SystemConfig	updateSystemConfig(String serviceHostIp, com.ebay.lightning.core.config.SystemConfig sysConfig) Update the configuration of the seed

Method Detail

reserve

com.ebay.lightning.core.beans.ReservationReceipt reserve(int count,
                                                         String serviceHostIp)

Attempts to reserve task execution bandwidth on the seed

Parameters:

count - load size of the request

serviceHostIp - the seed

Returns:

reservation receipt for the requested bandwidth. The seed might return ACCEPTED, DENIED or BUSY based on the current work load size of the seed.

getAuditReport

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

Get the audit report for the request id in compressed format.

Parameters:

sessionId - the session id submitted through submit(LightningRequest, String) method or returned by the reserve(int, String) method

serviceHostIp - the seed

Returns:

the audit report for the session id in compressed format. Returns the consolidated report if the session id is not present in the seed

getAuditJsonReport

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

Get the audit report for the request id in JSON format.

Parameters:

sessionId - the session id submitted through submit(LightningRequest, String) method or returned by the reserve(int, String) method

serviceHostIp - the seed

Returns:

the audit report for the session id in JSON format. Returns the consolidated report if the session id is not present in the seed

getAuditSummary

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

Get the audit summary in compressed format.

Parameters:

sessionId - the session id submitted through submit(LightningRequest, String) method or returned by the reserve(int, String) method

serviceHostIp - the seed

Returns:

the audit summary in compressed format.

getLightningStats

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

Get the system statistics of the seed

Parameters:

servingHostIp - the seed

Returns:

the SystemStatus that include information related to load, memory, CPU etc

submit

boolean submit(com.ebay.lightning.core.beans.LightningRequest request,
               String serviceHostIp)

Submits the request to the specific seed.

Parameters:

request - the request with the reservation receipt and task list

serviceHostIp - the seed that executes the request

Returns:

true if the submit operation is successful

updateSystemConfig

com.ebay.lightning.core.config.SystemConfig updateSystemConfig(String serviceHostIp,
                                                               com.ebay.lightning.core.config.SystemConfig sysConfig)

Update the configuration of the seed

Parameters:

serviceHostIp - the seed

sysConfig - the configuration changes to be applied

Returns:

the latest SystemConfig after updating

getSystemConfig

com.ebay.lightning.core.config.SystemConfig getSystemConfig(String serviceHostIp)

Get the configuration of the seed

Parameters:

serviceHostIp - the seed

Returns:

the SystemConfig that includes the seed capacity, retention policy etc

pollResults

com.ebay.lightning.core.beans.LightningResponse pollResults(String sessionId,
                                                            String serviceHostIp,
                                                            boolean pollDeltaOnly)

Get the result for the session id.

Parameters:

sessionId - the session id submitted through submit(LightningRequest, String) method or returned by the reserve(int, String) method

serviceHostIp - the seed

pollDeltaOnly - get the complete or only the delta

Returns:

the result for the request corresponding to sessionId