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()
abstract Charset	getCharset() Return the charset as defined by the header contenttype.
String	getCompartmentName()
String	getCompleteUrl()
String	getConditionalUrl(RestOperationTypeEnum theOperationType) Returns the conditional URL if this request has one, or null otherwise.
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.
IRequestOperationCallback	getRequestOperationCallback() Returns an invoker that can be called from user code to advise the server interceptors of any nested operations being invoked within operations.
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()
Map<Object,Object>	getUserData() Returns a map which can be used to hold any user specific data to pass it from one part of the request handling chain to another.
boolean	isRespondGzip()
boolean	isSubRequest() Is this request a sub-request (i.e.
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)
void	setSubRequest(boolean theSubRequest) Is this request a sub-request (i.e.

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

getByteStreamRequestContents

protected abstract byte[] getByteStreamRequestContents()

getCharset

public abstract Charset getCharset()

Return the charset as defined by the header contenttype. Return null if it is not set.

getCompartmentName

public String getCompartmentName()

getCompleteUrl

public String getCompleteUrl()

getConditionalUrl

public String getConditionalUrl(RestOperationTypeEnum theOperationType)

Returns the conditional URL if this request has one, or null otherwise. For an update or delete method, this is the part of the URL after the ?. For a create, this is the value of the If-None-Exist header.

Parameters:

theOperationType - The operation type to find the conditional URL for

Returns:

Returns the conditional URL if this request has one, or null otherwise

getFhirServerBase

public String getFhirServerBase()

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

Returns:

the fhir server base url

getHeader

public abstract String getHeader(String name)

getHeaders

public abstract List<String> getHeaders(String name)

getId

public IIdType getId()

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

getOperation

public String getOperation()

getParameters

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

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()

getRequestOperationCallback

public IRequestOperationCallback getRequestOperationCallback()

Returns an invoker that can be called from user code to advise the server interceptors of any nested operations being invoked within operations. This invoker acts as a proxy for all interceptors

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()

getResponse

public IRestfulResponse getResponse()

getRestOperationType

public RestOperationTypeEnum getRestOperationType()

getSecondaryOperation

public String getSecondaryOperation()

getServer

public abstract IRestfulServerDefaults getServer()

getServerBaseForRequest

public abstract String getServerBaseForRequest()

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

getUnqualifiedToQualifiedNames

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

getUserData

public Map<Object,Object> getUserData()

Returns a map which can be used to hold any user specific data to pass it from one part of the request handling chain to another. Data in this map can use any key, although user code should try to use keys which are specific enough to avoid conflicts.

A new map is created for each individual request that is handled by the server, so this map can be used (for example) to pass authorization details from an interceptor to the resource providers, or from an interceptor's IServerInterceptor.incomingRequestPreHandled(RestOperationTypeEnum, ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails) method to the IServerInterceptor.outgoingResponse(RequestDetails, org.hl7.fhir.instance.model.api.IBaseResource, javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) method.

isRespondGzip

public boolean isRespondGzip()

isSubRequest

public boolean isSubRequest()

Is this request a sub-request (i.e. a request within a batch or transaction)? This flag is used internally by hapi-fhir-jpaserver-base, but not used in the plain server library. You may use it in your client code as a hint when implementing transaction logic in the plain server.

Defaults to false

loadRequestContents

public final byte[] loadRequestContents()

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)

setResponse

public void setResponse(IRestfulResponse theResponse)

setRestOperationType

public void setRestOperationType(RestOperationTypeEnum theRestOperationType)

setSecondaryOperation

public void setSecondaryOperation(String theSecondaryOperation)

setSubRequest

public void setSubRequest(boolean theSubRequest)

Is this request a sub-request (i.e. a request within a batch or transaction)? This flag is used internally by hapi-fhir-jpaserver-base, but not used in the plain server library. You may use it in your client code as a hint when implementing transaction logic in the plain server.

Defaults to false