ca.uhn.fhir.rest.server

Interface IRestfulResponse

All Known Implementing Classes:

RestfulResponse, ServletRestfulResponse

public interface IRestfulResponse

Method Summary

Modifier and Type	Method and Description
void	addHeader(String headerKey, String headerValue)
Writer	getResponseWriter(int theStatusCode, String theStatusMessage, String theContentType, String theCharset, boolean theRespondGzip)
Object	returnResponse(ParseAction<?> outcome, int operationStatus, boolean allowPrefer, MethodOutcome response, String resourceName) This is only used for DSTU1 getTags operations, so it can be removed at some point when we drop DSTU1
Object	sendAttachmentResponse(IBaseBinary bin, int stausCode, String contentType)
Object	sendWriterResponse(int status, String contentType, String charset, Writer writer)
void	setOperationResourceId(IIdType theOperationResourceId)
void	setOperationResourceLastUpdated(IPrimitiveType<Date> theOperationResourceLastUpdated)
Object	streamResponseAsBundle(Bundle bundle, Set<SummaryEnum> summaryMode, boolean respondGzip, boolean requestIsBrowser)
Object	streamResponseAsResource(IBaseResource theActualResourceToReturn, boolean thePrettyPrint, Set<SummaryEnum> theSummaryMode, int theStatusCode, String theStatusMessage, boolean theRespondGzip, boolean theAddContentLocation)

Method Detail

streamResponseAsResource

Object streamResponseAsResource(IBaseResource theActualResourceToReturn,
                                boolean thePrettyPrint,
                                Set<SummaryEnum> theSummaryMode,
                                int theStatusCode,
                                String theStatusMessage,
                                boolean theRespondGzip,
                                boolean theAddContentLocation)
                         throws IOException

Throws:

IOException

streamResponseAsBundle

Object streamResponseAsBundle(Bundle bundle,
                              Set<SummaryEnum> summaryMode,
                              boolean respondGzip,
                              boolean requestIsBrowser)
                       throws IOException

Throws:

IOException

returnResponse

Object returnResponse(ParseAction<?> outcome,
                      int operationStatus,
                      boolean allowPrefer,
                      MethodOutcome response,
                      String resourceName)
               throws IOException

This is only used for DSTU1 getTags operations, so it can be removed at some point when we drop DSTU1

Throws:

IOException

getResponseWriter

Writer getResponseWriter(int theStatusCode,
                         String theStatusMessage,
                         String theContentType,
                         String theCharset,
                         boolean theRespondGzip)
                  throws UnsupportedEncodingException,
                         IOException

Throws:

UnsupportedEncodingException

IOException

sendWriterResponse

Object sendWriterResponse(int status,
                          String contentType,
                          String charset,
                          Writer writer)
                   throws IOException

Throws:

IOException

addHeader

void addHeader(String headerKey,
               String headerValue)

sendAttachmentResponse

Object sendAttachmentResponse(IBaseBinary bin,
                              int stausCode,
                              String contentType)
                       throws IOException

Throws:

IOException

setOperationResourceLastUpdated

void setOperationResourceLastUpdated(IPrimitiveType<Date> theOperationResourceLastUpdated)

setOperationResourceId

void setOperationResourceId(IIdType theOperationResourceId)