Package ca.uhn.fhir.rest.client.api

Interface IHttpRequest

All Known Implementing Classes:

BaseHttpRequest

public interface IHttpRequest

Http Request. Allows addition of headers and execution of the request.

Method Summary

Modifier and Type	Method	Description
void	addHeader(String theName, String theValue)	Add a header to the request
IHttpResponse	execute()	Execute the request
Map<String,List<String>>	getAllHeaders()
String	getHttpVerbName()	Return the HTTP verb (e.g.
String	getRequestBodyFromStream()	Return the request body as a string.
String	getUri()	Return the request URI, or null
UrlSourceEnum	getUrlSource()	Where was the URL from?
void	removeHeaders(String theHeaderName)	Remove any headers matching the given name
void	setUri(String theUrl)	Modify the request URI, or null
void	setUrlSource(UrlSourceEnum theUrlSource)	Where was the URL from?

Method Details

addHeader

void addHeader(String theName,
 String theValue)

Add a header to the request

Parameters:

theName - the header name

theValue - the header value

execute

IHttpResponse execute()
               throws IOException

Execute the request

Returns:

the response

Throws:

IOException

getAllHeaders

Map<String,List<String>> getAllHeaders()

Returns:

all request headers in lower case. Note that this method returns an immutable Map

getRequestBodyFromStream

String getRequestBodyFromStream()
                         throws IOException

Return the request body as a string. If this is not supported by the underlying technology, null is returned

Returns:

a string representation of the request or null if not supported or empty.

Throws:

IOException

getUri

String getUri()

Return the request URI, or null

See Also:

• getUri()

setUri

void setUri(String theUrl)

Modify the request URI, or null

See Also:

• setUrlSource(UrlSourceEnum)

getHttpVerbName

String getHttpVerbName()

Return the HTTP verb (e.g. "GET")

removeHeaders

void removeHeaders(String theHeaderName)

Remove any headers matching the given name

Parameters:

theHeaderName - The header name, e.g. "Accept" (must not be null or blank)

getUrlSource

UrlSourceEnum getUrlSource()

Where was the URL from?

Since:

5.0.0

setUrlSource

void setUrlSource(UrlSourceEnum theUrlSource)

Where was the URL from?

Since:

5.0.0