com.ebay.lightning.client.caller

Class RestAPICaller

java.lang.Object

com.ebay.lightning.client.caller.RestAPICaller

All Implemented Interfaces:

ServiceCaller

public class RestAPICaller
extends java.lang.Object
implements ServiceCaller

The REST API based implementation of ServiceCaller that communicates with the seeds through REST calls.

Author:

shashukla

See Also:

EmbeddedAPICaller

Constructor Summary

Constructors

Constructor and Description
RestAPICaller(LightningClientConfig config, com.ebay.lightning.core.utils.UrlUtils urlUtils)

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RestAPICaller

public RestAPICaller(LightningClientConfig config,
                     com.ebay.lightning.core.utils.UrlUtils urlUtils)

Method Detail

reserve

public com.ebay.lightning.core.beans.ReservationReceipt reserve(int forLoad,
                                                                java.lang.String serviceHostIp)

Description copied from interface: ServiceCaller

Attempts to reserve task execution bandwidth on the seed

Specified by:

reserve in interface ServiceCaller

Parameters:

forLoad - 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.

submit

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

Description copied from interface: ServiceCaller

Submits the request to the specific seed.

Specified by:

submit in interface ServiceCaller

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

pollResults

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

Description copied from interface: ServiceCaller

Get the result for the session id.

Specified by:

pollResults in interface ServiceCaller

Parameters:

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

serviceHostIp - the seed

pollDeltaOnly - get the complete or only the delta

Returns:

the result for the request corresponding to sessionId

getAuditReport

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

Description copied from interface: ServiceCaller

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

Specified by:

getAuditReport in interface ServiceCaller

Parameters:

sessionId - the session id submitted through ServiceCaller.submit(LightningRequest, String) method or returned by the ServiceCaller.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

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

Description copied from interface: ServiceCaller

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

Specified by:

getAuditJsonReport in interface ServiceCaller

Parameters:

sessionId - the session id submitted through ServiceCaller.submit(LightningRequest, String) method or returned by the ServiceCaller.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

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

Description copied from interface: ServiceCaller

Get the audit summary in compressed format.

Specified by:

getAuditSummary in interface ServiceCaller

Parameters:

serviceHostIp - the seed

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

Returns:

the audit summary in compressed format.

updateSystemConfig

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

Description copied from interface: ServiceCaller

Update the configuration of the seed

Specified by:

updateSystemConfig in interface ServiceCaller

Parameters:

serviceHostIp - the seed

sysConfig - the configuration changes to be applied

Returns:

the latest SystemConfig after updating

getSystemConfig

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

Description copied from interface: ServiceCaller

Get the configuration of the seed

Specified by:

getSystemConfig in interface ServiceCaller

Parameters:

serviceHostIp - the seed

Returns:

the SystemConfig that includes the seed capacity, retention policy etc

getLightningStats

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

Description copied from interface: ServiceCaller

Get the system statistics of the seed

Specified by:

getLightningStats in interface ServiceCaller

Parameters:

serviceHostIp - the seed

Returns:

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