org.ptolemy.ptango.lib.http

Class HttpResponse

java.lang.Object

org.ptolemy.ptango.lib.http.HttpResponse

public class HttpResponse
extends java.lang.Object

An HTTP response, comprised of selected fields from an HttpURLConnection. Useful for classes that want response data but should not have authority to open and close connections.

Since:

Ptolemy II 10.0

Version:

$Id$

Author:

Marten Lohstroh, Elizabeth Latronico

See Also:

HttpGet, HttpPost, HttpPut

Pt.AcceptedRating:

Red (eal)

Pt.ProposedRating:

Red (eal)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HttpResponse.ErrorSource Enumeration of possible sources of response errors, or none if none.

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static java.lang.String[]	_labels Labels for returning the status as a RecordToken

Constructor Summary

Constructors

Constructor and Description
HttpResponse() Construct a new, blank HttpResponse object.
HttpResponse(java.net.HttpURLConnection connection) Construct a new HttpResponse object from an HttpURLConnection object.
HttpResponse(java.lang.String message) Construct a new HttpResponse with the given message.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBody() Return the response body.
long	getContentLength() Return the length of the response body, in bytes, or -1 if length is unknown.
java.lang.String	getContentType() Return the Internet media (MIME) type of the response.
HttpResponse.ErrorSource	getErrorSource() Return the source of the error, ErrorSource.CLIENT or ErrorSource.SERVER, or ErrorSource.NONE if no error.
int	getResponseCode() Return a code indicating the status of the response.
java.lang.String	getResponseMessage() A message describing the status of the response.
RecordToken	getStatus() Return all status items as a RecordToken.
static Type	getStatusType() Return the Type of the token of getStatus().
boolean	isFurtherActionExpected() Return true if further action is expected of the client, e.g., issuing a second request; false otherwise.
boolean	isSuccessful() Return true if no errors were encountered; false otherwise.
void	setTimedOut() Create a timed-out response.
boolean	timedOut() Return true if the request timed out; false otherwise.

Methods inherited from class java.lang.Object

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

Field Detail

_labels

static final java.lang.String[] _labels

Labels for returning the status as a RecordToken

Constructor Detail

HttpResponse

public HttpResponse()

Construct a new, blank HttpResponse object.

HttpResponse

public HttpResponse(java.lang.String message)

Construct a new HttpResponse with the given message. Used for creating responses when errors occur on the Ptolemy side, such as an IOException.

Parameters:

message - The response message

HttpResponse

public HttpResponse(java.net.HttpURLConnection connection)

Construct a new HttpResponse object from an HttpURLConnection object.

Parameters:

connection - The connection object

Method Detail

getBody

public java.lang.String getBody()

Return the response body.

Returns:

The response body.

getContentLength

public long getContentLength()

Return the length of the response body, in bytes, or -1 if length is unknown.

Returns:

The length of the response body, in bytes, or -1 if length is unknown.

getContentType

public java.lang.String getContentType()

Return the Internet media (MIME) type of the response.

Returns:

The Internet media (MIME) type of the response.

getErrorSource

public HttpResponse.ErrorSource getErrorSource()

Return the source of the error, ErrorSource.CLIENT or ErrorSource.SERVER, or ErrorSource.NONE if no error.

Returns:

ErrorSource.CLIENT, ErrorSource.SERVER or Error.NONE.

getResponseCode

public int getResponseCode()

Return a code indicating the status of the response.

Returns:

A code indicating the status of the response.

getResponseMessage

public java.lang.String getResponseMessage()

A message describing the status of the response.

Returns:

A message describing the status of the response.

getStatus

public RecordToken getStatus()

Return all status items as a RecordToken.

Returns:

All status items as a RecordToken

getStatusType

public static Type getStatusType()

Return the Type of the token of getStatus(). Used for setting type constraints before the response content is available.

Returns:

The Type of the token of getStatus()

isFurtherActionExpected

public boolean isFurtherActionExpected()

Return true if further action is expected of the client, e.g., issuing a second request; false otherwise. Status codes 1xx and 3xx.

Returns:

True if further action is expected of the client, e.g., issuing a second request; false otherwise. Status codes 1xx and 3xx.

isSuccessful

public boolean isSuccessful()

Return true if no errors were encountered; false otherwise. Status codes 1xx, 2xx, 3xx.

Returns:

True if no errors were encountered. Status codes 1xx, 2xx, 3xx

setTimedOut

public void setTimedOut()

Create a timed-out response. Used for creating a response in the event of a send time out.

timedOut

public boolean timedOut()

Return true if the request timed out; false otherwise. Status code 408.

Returns:

True if the request timed out; false otherwise. Status code 408.