Package oauth.signpost.http

Interface HttpRequest

All Known Implementing Classes:

HttpRequestAdapter, HttpURLConnectionRequestAdapter, UrlStringRequestAdapter

public interface HttpRequest

A concise description of an HTTP request. Contains methods to access all those parts of an HTTP request which Signpost needs to sign a message. If you want to extend Signpost to sign a different kind of HTTP request than those currently supported, you'll have to write an adapter which implements this interface and a custom OAuthConsumer which performs the wrapping.

See Also:

HttpURLConnectionRequestAdapter

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.lang.String>	getAllHeaders()
java.lang.String	getContentType()
java.lang.String	getHeader(java.lang.String name)
java.io.InputStream	getMessagePayload()
java.lang.String	getMethod()
java.lang.String	getRequestUrl()
void	setHeader(java.lang.String name, java.lang.String value)
void	setRequestUrl(java.lang.String url)
java.lang.Object	unwrap()	Returns the wrapped request object, in case you must work directly on it.

Method Detail

getMethod

java.lang.String getMethod()

getRequestUrl

java.lang.String getRequestUrl()

setRequestUrl

void setRequestUrl(java.lang.String url)

setHeader

void setHeader(java.lang.String name,
               java.lang.String value)

getHeader

java.lang.String getHeader(java.lang.String name)

getAllHeaders

java.util.Map<java.lang.String,java.lang.String> getAllHeaders()

getMessagePayload

java.io.InputStream getMessagePayload()
                               throws java.io.IOException

Throws:

java.io.IOException

getContentType

java.lang.String getContentType()

unwrap

java.lang.Object unwrap()

Returns the wrapped request object, in case you must work directly on it.

Returns:

the wrapped request object