com.ebay.lightning.core.beans

Class LightningResponse

java.lang.Object

com.ebay.lightning.core.beans.LightningResponse

All Implemented Interfaces:

java.io.Serializable

public class LightningResponse
extends java.lang.Object
implements java.io.Serializable

The LightningResponse class defines the interface for the task agreed by the client and core. The class also contains LightningResponse.SuccessResponse to define a successful task, which is identified by a HTTP response code of '200' and LightningResponse.FailedResponse to define a failed task.

Author:

shashukla

See Also:

LightningRequest, LightningResponse.SuccessResponse, LightningResponse.FailedResponse, BatchReport, Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LightningResponse.FailedResponse
static class	LightningResponse.SuccessResponse

Constructor Summary

Constructors

Constructor and Description
LightningResponse(java.lang.String sessionId, LightningCoreConstants.WorkStatus status)

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.Integer,LightningResponse.FailedResponse>	getFailedResponses() Get the list of failed response.
java.lang.String	getSessionId() Get the sessionId of the request.
LightningCoreConstants.WorkStatus	getStatus() Get the LightningCoreConstants.WorkStatus of the request.
int	getSuccessCount() Get the successful count of tasks executed.
java.util.Map<java.lang.Integer,LightningResponse.SuccessResponse>	getSuccessResponses() Get the list of successful response.
int	getTotalCount() Get the total count of tasks executed.
boolean	isCompleted() Check of the request is completed.
java.lang.String	prettyPrint()
void	setFailedResponses(java.util.Map<java.lang.Integer,LightningResponse.FailedResponse> failedResponses) Set the list of failed response.
void	setSessionId(java.lang.String sessionId) Set the sessionId of the request.
void	setStatus(LightningCoreConstants.WorkStatus status) Set the LightningCoreConstants.WorkStatus of the request.
void	setSuccessCount(int successCount) Set the successful count of tasks executed.
void	setSuccessResponses(java.util.Map<java.lang.Integer,LightningResponse.SuccessResponse> successResponses) Set the list of successful response.
void	setTotalCount(int totalCount) Set the total count of tasks executed.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

LightningResponse

public LightningResponse(java.lang.String sessionId,
                         LightningCoreConstants.WorkStatus status)

Method Detail

getSessionId

public java.lang.String getSessionId()

Get the sessionId of the request.

Returns:

the sessionId of the request

setSessionId

public void setSessionId(java.lang.String sessionId)

Set the sessionId of the request.

Parameters:

sessionId - the sessionId to set

getTotalCount

public int getTotalCount()

Get the total count of tasks executed.

Returns:

the total count of tasks executed

setTotalCount

public void setTotalCount(int totalCount)

Set the total count of tasks executed.

Parameters:

totalCount - the total count of tasks executed

getSuccessCount

public int getSuccessCount()

Get the successful count of tasks executed.

Returns:

the successful count of tasks executed

setSuccessCount

public void setSuccessCount(int successCount)

Set the successful count of tasks executed.

Parameters:

successCount - the successful count of tasks executed

getStatus

public LightningCoreConstants.WorkStatus getStatus()

Get the LightningCoreConstants.WorkStatus of the request. The status can be one of (IN_QUEUE, RUNNING, DONE, STOPPED, CLEANED_UP)

Returns:

the LightningCoreConstants.WorkStatus of the request

setStatus

public void setStatus(LightningCoreConstants.WorkStatus status)

Set the LightningCoreConstants.WorkStatus of the request. The status can be one of (IN_QUEUE, RUNNING, DONE, STOPPED, CLEANED_UP)

Parameters:

status - the LightningCoreConstants.WorkStatus of the request

isCompleted

public boolean isCompleted()

Check of the request is completed.

Returns:

true if the all tasks in the request are completed.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

prettyPrint

public java.lang.String prettyPrint()

getFailedResponses

public java.util.Map<java.lang.Integer,LightningResponse.FailedResponse> getFailedResponses()

Get the list of failed response.

Returns:

the list of failed response

setFailedResponses

public void setFailedResponses(java.util.Map<java.lang.Integer,LightningResponse.FailedResponse> failedResponses)

Set the list of failed response.

Parameters:

failedResponses - the list of failed response

getSuccessResponses

public java.util.Map<java.lang.Integer,LightningResponse.SuccessResponse> getSuccessResponses()

Get the list of successful response.

Returns:

the list of successful response

setSuccessResponses

public void setSuccessResponses(java.util.Map<java.lang.Integer,LightningResponse.SuccessResponse> successResponses)

Set the list of successful response.

Parameters:

successResponses - the list of successful response