Package net.oauth.http

Class HttpMessage

java.lang.Object

net.oauth.http.HttpMessage

Direct Known Subclasses:

HttpResponseMessage

public class HttpMessage
extends Object

An HTTP request or response.

Author:

John Kristian

Field Summary

Fields

Modifier and Type	Field	Description
static String	ACCEPT_ENCODING
protected InputStream	body
static String	CONTENT_ENCODING
static String	CONTENT_LENGTH
static String	CONTENT_TYPE
static String	DEFAULT_CHARSET
List<Map.Entry<String,String>>	headers
String	method
static String	REQUEST	The name of a dump entry whose value is the HTTP request.
static String	RESPONSE	The name of a dump entry whose value is the HTTP response.
static String	STATUS_CODE	The name of a dump entry whose value is the HTTP status code.
URL	url

Constructor Summary

Constructors

Constructor	Description
HttpMessage()
HttpMessage(String method, URL url)
HttpMessage(String method, URL url, InputStream body)

Method Summary

Modifier and Type	Method	Description
void	dump(Map<String,Object> into)	Put a description of this message and its origins into the given Map.
InputStream	getBody()
String	getContentCharset()
String	getHeader(String name)	Get the value of the last header of the given name.
static HttpMessage	newRequest(OAuthMessage from, ParameterStyle style)	Construct an HTTP request from this OAuth message.
protected InputStream	openBody()
String	removeHeaders(String name)	Remove all headers of the given name.

Methods inherited from class java.lang.Object

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

Field Detail

method

public String method

url

public URL url

headers

public final List<Map.Entry<String,String>> headers

body

protected InputStream body

REQUEST

public static final String REQUEST

The name of a dump entry whose value is the HTTP request.

See Also:

Constant Field Values

RESPONSE

public static final String RESPONSE

The name of a dump entry whose value is the HTTP response.

See Also:

Constant Field Values

STATUS_CODE

public static final String STATUS_CODE

The name of a dump entry whose value is the HTTP status code.

See Also:

Constant Field Values

ACCEPT_ENCODING

public static final String ACCEPT_ENCODING

See Also:

Constant Field Values

CONTENT_ENCODING

public static final String CONTENT_ENCODING

See Also:

Constant Field Values

CONTENT_LENGTH

public static final String CONTENT_LENGTH

See Also:

Constant Field Values

CONTENT_TYPE

public static final String CONTENT_TYPE

See Also:

Constant Field Values

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

See Also:

Constant Field Values

Constructor Detail

HttpMessage

public HttpMessage()

HttpMessage

public HttpMessage(String method,
                   URL url)

HttpMessage

public HttpMessage(String method,
                   URL url,
                   InputStream body)

Method Detail

getHeader

public final String getHeader(String name)

Get the value of the last header of the given name. The name is case-insensitive.

removeHeaders

public String removeHeaders(String name)

Remove all headers of the given name. The name is case insensitive.

Returns:

the value of the last header with that name, or null to indicate there was no such header

getContentCharset

public final String getContentCharset()

getBody

public final InputStream getBody()
                          throws IOException

Throws:

IOException

openBody

protected InputStream openBody()
                        throws IOException

Throws:

IOException

dump

public void dump(Map<String,Object> into)
          throws IOException

Put a description of this message and its origins into the given Map.

Throws:

IOException

newRequest

public static HttpMessage newRequest(OAuthMessage from,
                                     ParameterStyle style)
                              throws IOException

Construct an HTTP request from this OAuth message.

Parameters:

style - where to put the OAuth parameters, within the HTTP request

Throws:

IOException