com.ebay.lightning.core.services

Interface TaskExecutionService

All Known Implementing Classes:

TaskExecutionServiceImpl

public interface TaskExecutionService

The TaskExecutionService interface defines the operations for processing the request and getting the response.

Author:

shashukla

See Also:

TaskExecutionServiceImpl, TaskExecutionManager

Method Summary

Modifier and Type	Method and Description
java.util.List<LightningRequestReport>	getAuditReports(java.lang.String sessionId) Get the detailed execution reports.
SystemStatus	getLightningStats() Get the system metrics including CPU, physical and JVM memory.
LightningRequestReport	getReport(java.lang.String sessionId) Get the detailed execution report for the request.
SystemConfig	getSystemConfig() Get the system configuration including capacity, retention policy etc
LightningResponse	pollResponse(java.lang.String sessionId, boolean pollDeltaOnly) Poll the current execution state for the request submitted by #submit(LightningRequest) method.
ReservationReceipt	reserve(int load) Check for bandwidth to make reservation for the specified load.
void	submit(LightningRequest request) Submit a request to get executed asynchronously at high speed.
SystemConfig	updateSystemConfig(SystemConfig sysConfig) Update the system configuration including capacity, retention policy etc

Method Detail

submit

void submit(LightningRequest request)

Submit a request to get executed asynchronously at high speed. The request should contain the ReservationReceipt returned by the reserve(int) call.

Parameters:

request - contains the list of Task and configuration to execute

pollResponse

LightningResponse pollResponse(java.lang.String sessionId,
                               boolean pollDeltaOnly)

Poll the current execution state for the request submitted by #submit(LightningRequest) method. This method id helpful to check if the request has completed.

Parameters:

sessionId - the session id of the LightningRequest

pollDeltaOnly - get full if true and delta response if false

Returns:

LightningResponse that has the current state of task execution

getReport

LightningRequestReport getReport(java.lang.String sessionId)

Get the detailed execution report for the request. This method is usually called after checking if the request is completed by calling pollResponse(String, boolean)

Parameters:

sessionId - the session id of the LightningRequest

Returns:

LightningRequestReport that has the detailed execution report of the request

reserve

ReservationReceipt reserve(int load)

Check for bandwidth to make reservation for the specified load.

Parameters:

load - the load to check for reservation

Returns:

the reservation receipt containing either of the state ACCEPTED, DENIED, BUSY

getAuditReports

java.util.List<LightningRequestReport> getAuditReports(java.lang.String sessionId)

Get the detailed execution reports.

Parameters:

sessionId - the session id of the request

Returns:

the list of LightningRequestReport available in the store

getLightningStats

SystemStatus getLightningStats()

Get the system metrics including CPU, physical and JVM memory.

Returns:

the current system status

updateSystemConfig

SystemConfig updateSystemConfig(SystemConfig sysConfig)
                         throws java.lang.Exception

Update the system configuration including capacity, retention policy etc

Parameters:

sysConfig - the system configuration changes to make

Returns:

the system configuration after update

Throws:

java.lang.Exception - when the update fails

getSystemConfig

SystemConfig getSystemConfig()

Get the system configuration including capacity, retention policy etc

Returns:

the current system configuration