com.ebay.lightning.core.beans

Class URLTask

java.lang.Object

com.ebay.lightning.core.beans.Task

com.ebay.lightning.core.beans.URLTask

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ChainedURLTask

public class URLTask
extends Task

The URLTask class holds additional properties for the Task like proxy information. Additionally it holds information on the response of URL execution like status code, http body etc.

Author:

shashukla

See Also:

ChainedURLTask, Serialized Form

Constructor Summary

Constructors

Constructor and Description
URLTask(java.lang.String url)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBody() Get the response body for the URL request.
java.lang.String	getCompleteURL() Get the full URL.
java.lang.String	getHost() Get the host from the URL.
java.lang.String	getHostIPAddress() Get the IP address of the host set by InetSocketAddressCache.
java.lang.String	getPath() Get the full URL path.
int	getPort() Get the port from the URL.
int	getStatusCode() Get the URL response code.
boolean	isUseProxyServer() Check if proxy is enabled.
void	setBody(java.lang.String body) Set the response body for the URL request.
void	setHostIPAddress(java.lang.String hostIPAddress) Set the IP address of the host.
void	setStatusCode(int statusCode) Set the HTTP status code from the URL response.
void	setUseProxyServer(boolean useProxyServer) Enable proxy for the request.

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

getErrorMsg, getLastTaskStatusUpdateTime, getStatus, getUrl, hasFailed, setErrorMsg, setLastTaskStatusUpdateTime, setStatus, setUrl

Methods inherited from class java.lang.Object

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

Constructor Detail

URLTask

public URLTask(java.lang.String url)

Method Detail

setStatusCode

public void setStatusCode(int statusCode)

Set the HTTP status code from the URL response.

Parameters:

statusCode - the URL response code

getStatusCode

public int getStatusCode()

Get the URL response code.

Returns:

the URL response code

getPort

public int getPort()

Get the port from the URL.

Returns:

the port from the URL

getHost

public java.lang.String getHost()

Get the host from the URL.

Returns:

the host from the URL

getPath

public java.lang.String getPath()

Get the full URL path.

Returns:

the full URL path

getHostIPAddress

public java.lang.String getHostIPAddress()

Get the IP address of the host set by InetSocketAddressCache.

Returns:

the IP address of the host used to make connection. Returns the proxy IP if proxy is enabled via setUseProxyServer(boolean). Or else host IP is returned.

setHostIPAddress

public void setHostIPAddress(java.lang.String hostIPAddress)

Set the IP address of the host.

Parameters:

hostIPAddress - the IP address of the host used to make connection

isUseProxyServer

public boolean isUseProxyServer()

Check if proxy is enabled.

Returns:

true if proxy is enabled

setUseProxyServer

public void setUseProxyServer(boolean useProxyServer)

Enable proxy for the request.

Parameters:

useProxyServer - true if proxy enabled

getCompleteURL

public java.lang.String getCompleteURL()

Get the full URL.

Returns:

the full URL

getBody

public java.lang.String getBody()

Get the response body for the URL request.

Returns:

the response body for the URL request

setBody

public void setBody(java.lang.String body)

Set the response body for the URL request.

Parameters:

body - the response body for the URL request