Package ca.uhn.fhir.rest.server.servlet

Class ServletRequestDetails

java.lang.Object

ca.uhn.fhir.rest.api.server.RequestDetails

ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

All Implemented Interfaces:

IHasServletAttributes

Direct Known Subclasses:

ServletSubRequestDetails

public class ServletRequestDetails
extends RequestDetails
implements IHasServletAttributes

Field Summary

Fields inherited from class ca.uhn.fhir.rest.api.server.RequestDetails

BAD_STREAM_PLACEHOLDER

Constructor Summary

Constructors

Constructor	Description
ServletRequestDetails()	Constructor for testing only
ServletRequestDetails(ca.uhn.fhir.interceptor.api.IInterceptorBroadcaster theInterceptorBroadcaster)	Constructor
ServletRequestDetails(ServletRequestDetails theRequestDetails)	Copy constructor

Method Summary

Modifier and Type	Method	Description
void	addHeader(String theName, String theValue)	Adds a new header
Object	getAttribute(String theAttributeName)	Deprecated. Use RequestDetails.getUserData().
protected byte[]	getByteStreamRequestContents()
Charset	getCharset()	Return the charset as defined by the header contenttype.
ca.uhn.fhir.context.FhirContext	getFhirContext()	Returns the HAPI FHIR Context associated with this request
String	getHeader(String name)
Map<String,List<String>>	getHeaders()
List<String>	getHeaders(String name)
InputStream	getInputStream()	Retrieves the body of the request as binary data.
Reader	getReader()	Retrieves the body of the request as character data using a BufferedReader.
RestfulServer	getServer()
String	getServerBaseForRequest()	Returns the server base URL (with no trailing '/') for a given request
Object	getServletAttribute(String theAttributeName)	Gets an attribute from the servlet request.
jakarta.servlet.http.HttpServletRequest	getServletRequest()
jakarta.servlet.http.HttpServletResponse	getServletResponse()
boolean	isPreferRespondAsync()	Returns true if the `Prefer` header contains a value of `respond-async`
void	setAttribute(String theAttributeName, Object theAttributeValue)	Deprecated. Use RequestDetails.getUserData().
void	setHeaders(String theName, List<String> theValue)	Replaces any existing header(s) with the given name using a List of new header values
void	setServer(RestfulServer theServer)
void	setServletAttribute(String theAttributeName, Object theAttributeValue)	Sets an attribute on the servlet request.
ServletRequestDetails	setServletRequest(jakarta.servlet.http.HttpServletRequest myServletRequest)
void	setServletResponse(jakarta.servlet.http.HttpServletResponse myServletResponse)

Methods inherited from class ca.uhn.fhir.rest.api.server.RequestDetails

addParameter, getCompartmentName, getCompleteUrl, getConditionalUrl, getFhirServerBase, getFixedConditionalUrl, getId, getInterceptorBroadcaster, getMaxRetries, getOperation, getParameters, getRequestContentsIfLoaded, getRequestId, getRequestPath, getRequestStopwatch, getRequestType, getResource, getResourceName, getResponse, getRestOperationType, getSecondaryOperation, getTenantId, getTransactionGuid, getUnqualifiedToQualifiedNames, getUserData, isPreferAsync, isRespondGzip, isRetry, isRewriteHistory, isSubRequest, loadRequestContents, removeParameter, setCompartmentName, setCompleteUrl, setFhirServerBase, setFixedConditionalUrl, setId, setMaxRetries, setOperation, setParameters, setRequestContents, setRequestId, setRequestPath, setRequestType, setResource, setResourceName, setRespondGzip, setResponse, setRestOperationType, setRetry, setRewriteHistory, setSecondaryOperation, setSubRequest, setTenantId, setTransactionGuid

Methods inherited from class java.lang.Object

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

Constructor Details

ServletRequestDetails

public ServletRequestDetails()

Constructor for testing only

ServletRequestDetails

public ServletRequestDetails(ca.uhn.fhir.interceptor.api.IInterceptorBroadcaster theInterceptorBroadcaster)

Constructor

ServletRequestDetails

public ServletRequestDetails(ServletRequestDetails theRequestDetails)

Copy constructor

Method Details

getByteStreamRequestContents

protected byte[] getByteStreamRequestContents()

Specified by:

getByteStreamRequestContents in class RequestDetails

getCharset

public Charset getCharset()

Description copied from class: RequestDetails

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

Specified by:

getCharset in class RequestDetails

getFhirContext

public ca.uhn.fhir.context.FhirContext getFhirContext()

Description copied from class: RequestDetails

Returns the HAPI FHIR Context associated with this request

Specified by:

getFhirContext in class RequestDetails

getHeader

public String getHeader(String name)

Specified by:

getHeader in class RequestDetails

getHeaders

public List<String> getHeaders(String name)

Specified by:

getHeaders in class RequestDetails

addHeader

public void addHeader(String theName,
 String theValue)

Description copied from class: RequestDetails

Adds a new header

Specified by:

addHeader in class RequestDetails

Parameters:

theName - The header name

theValue - The header value

setHeaders

public void setHeaders(String theName,
 List<String> theValue)

Description copied from class: RequestDetails

Replaces any existing header(s) with the given name using a List of new header values

Specified by:

setHeaders in class RequestDetails

Parameters:

theName - The header name

theValue - The header value

getServletAttribute

public Object getServletAttribute(String theAttributeName)

Gets an attribute from the servlet request. Attributes are used for interacting with servlet request attributes to communicate between servlet filters. These methods should not be used to pass information between interceptor methods. Use RequestDetails.getUserData() instead to pass information between interceptor methods.

Specified by:

getServletAttribute in interface IHasServletAttributes

Parameters:

theAttributeName - The attribute name

Returns:

The attribute value, or null if the attribute is not set

setServletAttribute

public void setServletAttribute(String theAttributeName,
 Object theAttributeValue)

Sets an attribute on the servlet request. Attributes are used for interacting with servlet request attributes to communicate between servlet filters. These methods should not be used to pass information between interceptor methods. Use RequestDetails.getUserData() instead to pass information between interceptor methods.

Specified by:

setServletAttribute in interface IHasServletAttributes

Parameters:

theAttributeName - The attribute name

theAttributeValue - The attribute value

getAttribute

@Deprecated
public Object getAttribute(String theAttributeName)

Deprecated.

Use RequestDetails.getUserData(). If servlet attributes are truly required, then use IHasServletAttributes.getServletAttribute(String).

Overrides:

getAttribute in class RequestDetails

setAttribute

@Deprecated
public void setAttribute(String theAttributeName,
 Object theAttributeValue)

Deprecated.

Use RequestDetails.getUserData(). If servlet attributes are truly required, then use IHasServletAttributes.setServletAttribute(String, Object).

Overrides:

setAttribute in class RequestDetails

getInputStream

public InputStream getInputStream()
                           throws IOException

Description copied from class: RequestDetails

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

Specified by:

getInputStream in class RequestDetails

Returns:

a InputStream object containing the body of the request

Throws:

IOException - if an input or output exception occurred

getReader

public Reader getReader()
                 throws IOException

Description copied from class: RequestDetails

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 RequestDetails.getInputStream() may be called to read the body, not both.

Specified by:

getReader in class RequestDetails

Returns:

a Reader containing the body of the request

Throws:

IOException - if an input or output exception occurred

See Also:

• ServletRequest.getInputStream()

getServer

public RestfulServer getServer()

Specified by:

getServer in class RequestDetails

getServerBaseForRequest

public String getServerBaseForRequest()

Description copied from class: RequestDetails

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

Specified by:

getServerBaseForRequest in class RequestDetails

getServletRequest

public jakarta.servlet.http.HttpServletRequest getServletRequest()

getServletResponse

public jakarta.servlet.http.HttpServletResponse getServletResponse()

setServer

public void setServer(RestfulServer theServer)

setServletRequest

public ServletRequestDetails setServletRequest(@Nonnull
 jakarta.servlet.http.HttpServletRequest myServletRequest)

setServletResponse

public void setServletResponse(jakarta.servlet.http.HttpServletResponse myServletResponse)

getHeaders

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

isPreferRespondAsync

public boolean isPreferRespondAsync()

Returns true if the `Prefer` header contains a value of `respond-async`