com.ebay.lightning.core.beans

Class ChainedURLTask

java.lang.Object

com.ebay.lightning.core.beans.Task

com.ebay.lightning.core.beans.URLTask

com.ebay.lightning.core.beans.ChainedURLTask

All Implemented Interfaces:

java.io.Serializable

public class ChainedURLTask
extends URLTask
implements java.io.Serializable

The ChainedURLTask class can execute a set of URLs sequentially. The URL execution stops when it encounters an error in the sequential execution process.

Author:

shashukla

See Also:

URLTask, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ChainedURLTask()

Method Summary

Modifier and Type	Method and Description
void	addUrlTask(URLTask urlTask) Add an URL task to the list of URLs.
java.lang.String	getCompleteURL() Get the complete URL of the current execution task.
java.lang.String	getErrorMsg() Get the error message if any for the current execution task.
java.lang.String	getHost() Get the host of the current execution task.
java.lang.String	getHostIPAddress() Get the host IP of the current execution task.
java.lang.Long	getLastTaskStatusUpdateTime() Get the last update time when there is a change in task status for the current execution task.
java.lang.String	getPath() Get the URL path of the current execution task.
int	getPort() Get the port of the current execution task.
LightningCoreConstants.TaskStatus	getStatus() Get the state of the current execution task.
int	getStatusCode() Get the HTTP status code of the current execution task.
boolean	hasNext() Check for more task to be executed in the task list.
boolean	isUseProxyServer() Check if proxy is enabled for the current execution task.
void	moveToNext() Move to the next task to be executed in the task list.
void	setErrorMsg(java.lang.String errorMsg) Set the error message if any for the current execution task.
void	setHostIPAddress(java.lang.String hostIPAddress) Set the host IP of the current execution task.
void	setLastTaskStatusUpdateTime(java.lang.Long lastTaskStatusUpdateTime) Set the last update time when there is a change in task status for the current execution task.
void	setStatus(LightningCoreConstants.TaskStatus status) Set the state of the current execution task.
void	setStatusCode(int statusCode) Set the HTTP status code of the current execution task.
void	setUseProxyServer(boolean useProxyServer) Enable proxy for the current execution task.

Methods inherited from class com.ebay.lightning.core.beans.URLTask

getBody, setBody

Methods inherited from class com.ebay.lightning.core.beans.Task

getUrl, hasFailed, setUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

ChainedURLTask

public ChainedURLTask()
               throws java.net.URISyntaxException

Throws:

java.net.URISyntaxException

Method Detail

addUrlTask

public void addUrlTask(URLTask urlTask)

Add an URL task to the list of URLs.

Parameters:

urlTask - the URL task to be added to the list

getStatus

public LightningCoreConstants.TaskStatus getStatus()

Get the state of the current execution task.

Refer LightningCoreConstants.TaskStatus on the possible states for the task.

Overrides:

getStatus in class Task

Returns:

the state of the current execution task

setStatus

public void setStatus(LightningCoreConstants.TaskStatus status)

Set the state of the current execution task.

Refer LightningCoreConstants.TaskStatus on the possible states for the task.

Overrides:

setStatus in class Task

Parameters:

status - the state of the current execution task

setStatusCode

public void setStatusCode(int statusCode)

Set the HTTP status code of the current execution task.

Overrides:

setStatusCode in class URLTask

Parameters:

statusCode - the HTTP status code of the current execution task

getStatusCode

public int getStatusCode()

Get the HTTP status code of the current execution task.

Overrides:

getStatusCode in class URLTask

Returns:

the HTTP status code of the current execution task

getPort

public int getPort()

Get the port of the current execution task.

Overrides:

getPort in class URLTask

Returns:

the port of the current execution task

getHost

public java.lang.String getHost()

Get the host of the current execution task.

Overrides:

getHost in class URLTask

Returns:

the host of the current execution task

getPath

public java.lang.String getPath()

Get the URL path of the current execution task.

Overrides:

getPath in class URLTask

Returns:

the URL path of the current execution task

isUseProxyServer

public boolean isUseProxyServer()

Check if proxy is enabled for the current execution task.

Overrides:

isUseProxyServer in class URLTask

Returns:

true if proxy is enabled for the current execution task

setUseProxyServer

public void setUseProxyServer(boolean useProxyServer)

Enable proxy for the current execution task.

Overrides:

setUseProxyServer in class URLTask

Parameters:

useProxyServer - enable proxy for the current execution task

getHostIPAddress

public java.lang.String getHostIPAddress()

Get the host IP of the current execution task.

Overrides:

getHostIPAddress in class URLTask

Returns:

the host IP of the current execution task. If setUseProxyServer(boolean) is enabled, the proxy IP is returned. Or else the host IP is returned.

setHostIPAddress

public void setHostIPAddress(java.lang.String hostIPAddress)

Set the host IP of the current execution task.

Overrides:

setHostIPAddress in class URLTask

Parameters:

hostIPAddress - the host IP of the current execution task

getCompleteURL

public java.lang.String getCompleteURL()

Get the complete URL of the current execution task.

Overrides:

getCompleteURL in class URLTask

Returns:

the complete URL of the current execution task

getErrorMsg

public java.lang.String getErrorMsg()

Get the error message if any for the current execution task.

Overrides:

getErrorMsg in class Task

Returns:

the error message if any for the current execution task. If successful, null is returned

setErrorMsg

public void setErrorMsg(java.lang.String errorMsg)

Set the error message if any for the current execution task.

Overrides:

setErrorMsg in class Task

Parameters:

errorMsg - the error message if any for the current execution task

getLastTaskStatusUpdateTime

public java.lang.Long getLastTaskStatusUpdateTime()

Get the last update time when there is a change in task status for the current execution task.

Overrides:

getLastTaskStatusUpdateTime in class Task

Returns:

the last update time when there is a change in task status for the current execution task

setLastTaskStatusUpdateTime

public void setLastTaskStatusUpdateTime(java.lang.Long lastTaskStatusUpdateTime)

Set the last update time when there is a change in task status for the current execution task.

Overrides:

setLastTaskStatusUpdateTime in class Task

Parameters:

lastTaskStatusUpdateTime - the last update time when there is a change in task status for the current execution task

hasNext

public boolean hasNext()

Check for more task to be executed in the task list.

Returns:

true if there are more tasks to be executed.

moveToNext

public void moveToNext()

Move to the next task to be executed in the task list. hasNext() method has to be called before calling this method.