ca.uhn.fhir.rest.method

Class RequestDetails

java.lang.Object

ca.uhn.fhir.rest.method.RequestDetails

Direct Known Subclasses:

ServletRequestDetails

public abstract class RequestDetails
extends Object

Constructor Summary

Constructors

Constructor and Description
RequestDetails()

Method Summary

Modifier and Type	Method and Description
protected abstract byte[]	getByteStreamRequestContents()
String	getCompartmentName()
String	getCompleteUrl()
String	getFhirServerBase() The fhir server base url, independant of the query being executed
abstract String	getHeader(String name)
abstract List<String>	getHeaders(String name)
IIdType	getId()
abstract InputStream	getInputStream() Retrieves the body of the request as binary data.
String	getOperation()
Map<String,String[]>	getParameters()
abstract Reader	getReader() Retrieves the body of the request as character data using a BufferedReader.
String	getRequestPath() The part of the request URL that comes after the server base.
RequestTypeEnum	getRequestType()
String	getResourceName()
IRestfulResponse	getResponse()
RestOperationTypeEnum	getRestOperationType()
String	getSecondaryOperation()
abstract IRestfulServerDefaults	getServer()
abstract String	getServerBaseForRequest() Returns the server base URL (with no trailing '/') for a given request
Map<String,List<String>>	getUnqualifiedToQualifiedNames()
boolean	isRespondGzip()
byte[]	loadRequestContents()
void	setCompartmentName(String theCompartmentName)
void	setCompleteUrl(String theCompleteUrl)
void	setFhirServerBase(String theFhirServerBase)
void	setId(IIdType theId)
void	setOperation(String theOperation)
void	setParameters(Map<String,String[]> theParams)
void	setRequestPath(String theRequestPath)
void	setRequestType(RequestTypeEnum theRequestType)
void	setResourceName(String theResourceName)
void	setRespondGzip(boolean theRespondGzip)
void	setResponse(IRestfulResponse theResponse)
void	setRestOperationType(RestOperationTypeEnum theRestOperationType)
void	setSecondaryOperation(String theSecondaryOperation)

Methods inherited from class java.lang.Object

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

Constructor Detail

RequestDetails

public RequestDetails()

Method Detail

getCompartmentName

public String getCompartmentName()

getCompleteUrl

public String getCompleteUrl()

getFhirServerBase

public String getFhirServerBase()

The fhir server base url, independant of the query being executed

Returns:

the fhir server base url

getId

public IIdType getId()

getOperation

public String getOperation()

getParameters

public Map<String,String[]> getParameters()

getRequestPath

public String getRequestPath()

The part of the request URL that comes after the server base.

Will not contain a leading '/'

getRequestType

public RequestTypeEnum getRequestType()

getResourceName

public String getResourceName()

getRestOperationType

public RestOperationTypeEnum getRestOperationType()

getSecondaryOperation

public String getSecondaryOperation()

getServer

public abstract IRestfulServerDefaults getServer()

getUnqualifiedToQualifiedNames

public Map<String,List<String>> getUnqualifiedToQualifiedNames()

isRespondGzip

public boolean isRespondGzip()

setCompartmentName

public void setCompartmentName(String theCompartmentName)

setCompleteUrl

public void setCompleteUrl(String theCompleteUrl)

setFhirServerBase

public void setFhirServerBase(String theFhirServerBase)

setId

public void setId(IIdType theId)

setOperation

public void setOperation(String theOperation)

setParameters

public void setParameters(Map<String,String[]> theParams)

setRequestPath

public void setRequestPath(String theRequestPath)

setRequestType

public void setRequestType(RequestTypeEnum theRequestType)

setResourceName

public void setResourceName(String theResourceName)

setRespondGzip

public void setRespondGzip(boolean theRespondGzip)

setRestOperationType

public void setRestOperationType(RestOperationTypeEnum theRestOperationType)

setSecondaryOperation

public void setSecondaryOperation(String theSecondaryOperation)

getResponse

public IRestfulResponse getResponse()

setResponse

public void setResponse(IRestfulResponse theResponse)

getHeader

public abstract String getHeader(String name)

loadRequestContents

public final byte[] loadRequestContents()

getByteStreamRequestContents

protected abstract byte[] getByteStreamRequestContents()

getHeaders

public abstract List<String> getHeaders(String name)

getReader

public abstract Reader getReader()
                          throws IOException

Retrieves the body of the request as character data using a BufferedReader. The reader translates the character data according to the character encoding used on the body. Either this method or getInputStream() may be called to read the body, not both.

Returns:

a Reader containing the body of the request

Throws:

UnsupportedEncodingException - if the character set encoding used is not supported and the text cannot be decoded

IllegalStateException - if getInputStream() method has been called on this request

IOException - if an input or output exception occurred

See Also:

ServletRequest.getInputStream()

getInputStream

public abstract InputStream getInputStream()
                                    throws IOException

Retrieves the body of the request as binary data. Either this method or getReader() may be called to read the body, not both.

Returns:

a InputStream object containing the body of the request

Throws:

IllegalStateException - if the getReader() method has already been called for this request

IOException - if an input or output exception occurred

getServerBaseForRequest

public abstract String getServerBaseForRequest()

Returns the server base URL (with no trailing '/') for a given request