org.ptolemy.ptango.lib.http

Class HttpRequest

java.lang.Object

org.ptolemy.ptango.lib.http.HttpRequest

public class HttpRequest
extends java.lang.Object

An object representation of an HTTP request. This class combines all components of a message (method type, header properties, body) and combines it with a target URL and a timeout to wait for a response. After instantiation, the execute() method can be used (repeatedly) to send requests and wait for a response.

Since:

Ptolemy II 10.0

Version:

$Id: HttpRequest.java 70392 2014-10-22 22:31:22Z cxh $

Author:

Marten Lohstroh

See Also:

HttpGet, HttpPost, HttpPut

Accepted Rating:

Red (eal)

Proposed Rating:

Red (eal)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpRequest.Method Enumeration of possible HTTP request methods.

Constructor Summary

Constructors

Constructor and Description
HttpRequest() Construct a new, empty HTTP request.
HttpRequest(java.net.URL url, HttpRequest.Method method, RecordToken properties, java.lang.String body, int timeout) Construct a new HTTP request, parameterized with a URL, method, properties, body, and time out.

Method Summary

Modifier and Type	Method and Description
void	disconnect() Disconnect the current HttpURLConnection.
HttpResponse	execute() Issue a HTTP request using the specified URL.
java.lang.String	getBody() Get the body of the message.
java.net.HttpURLConnection	getConnection() Get the current connection.
java.lang.String	getLineBreak() Set the lineBreak character sequence.
HttpRequest.Method	getMethod() Get the request method.
RecordToken	getProperties() Get the properties that determine the HTTP header.
int	getTimeout() Get the timeout observed upon execution of the request.
java.net.URL	getUrl() Get the currently set URL.
void	setBody(java.lang.String body) Set the body of the message.
void	setConnection(java.net.HttpURLConnection connection) Set the current connection.
void	setLineBreak(java.lang.String lineBreak) Set the lineBreak character sequence.
void	setMethod(HttpRequest.Method method) Set the request method.
void	setProperties(RecordToken properties) Set the properties that determine the HTTP header.
void	setTimeout(int timeout) Set the timeout observed upon execution of the request.
void	setUrl(java.net.URL url) Set the url to send this HTTP request to.

Methods inherited from class java.lang.Object

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

Constructor Detail

HttpRequest

public HttpRequest()

Construct a new, empty HTTP request.

HttpRequest

public HttpRequest(java.net.URL url,
                   HttpRequest.Method method,
                   RecordToken properties,
                   java.lang.String body,
                   int timeout)

Construct a new HTTP request, parameterized with a URL, method, properties, body, and time out.

Parameters:

url - The URL to send the request to.

method - The request method (e.g., GET/POST/PUT ...). According to the Java documentation, "GET POST HEAD OPTIONS PUT DELETE TRACE are legal, subject to protocol restrictions."

properties - Optional properties included as part of the header

body - The message content to send

timeout - The maximum timeout to wait for obtaining a connection, issuing the request and receiving a response

Method Detail

execute

public HttpResponse execute()

Issue a HTTP request using the specified URL. Open a connection, send a header, a body if applicable, and wait for a response. Return the response, or throw an error if no response is returned within the specified timeout.

Returns:

An HttpRsponse object containing the response from the server

disconnect

public void disconnect()

Disconnect the current HttpURLConnection.

getBody

public java.lang.String getBody()

Get the body of the message.

Returns:

The body string.

See Also:

setBody(String)

getConnection

public java.net.HttpURLConnection getConnection()

Get the current connection.

Returns:

The current connection.

See Also:

setConnection(HttpURLConnection)

getLineBreak

public java.lang.String getLineBreak()

Set the lineBreak character sequence.

Returns:

A String containing the line break sequence.

See Also:

setLineBreak(String)

getMethod

public HttpRequest.Method getMethod()

Get the request method.

Returns:

The request method.

See Also:

setMethod(Method)

getProperties

public RecordToken getProperties()

Get the properties that determine the HTTP header.

Returns:

A record token that maps header fields to strings.

See Also:

setProperties(RecordToken)

getTimeout

public int getTimeout()

Get the timeout observed upon execution of the request.

Returns:

An integer denoting time in milliseconds.

See Also:

setTimeout(int)

getUrl

public java.net.URL getUrl()

Get the currently set URL.

Returns:

The URL.

See Also:

setUrl(URL)

setBody

public void setBody(java.lang.String body)

Set the body of the message.

Parameters:

body - The body of the message.

See Also:

getBody()

setConnection

public void setConnection(java.net.HttpURLConnection connection)

Set the current connection.

Parameters:

connection - A HttpURLConnection object.

See Also:

getConnection()

setLineBreak

public void setLineBreak(java.lang.String lineBreak)

Set the lineBreak character sequence.

Parameters:

lineBreak - A String containing the line break sequence.

See Also:

getLineBreak()

setMethod

public void setMethod(HttpRequest.Method method)

Set the request method.

Parameters:

method - The request method.

See Also:

getMethod()

setProperties

public void setProperties(RecordToken properties)

Set the properties that determine the HTTP header.

Parameters:

properties - A record token that maps header fields to strings.

See Also:

getProperties()

setTimeout

public void setTimeout(int timeout)

Set the timeout observed upon execution of the request.

Parameters:

timeout - An integer denoting time in milliseconds.

See Also:

getTimeout()

setUrl

public void setUrl(java.net.URL url)

Set the url to send this HTTP request to.

Parameters:

url - The target URL.

See Also:

getUrl()