ca.uhn.fhir.rest.server

Class RestfulServerUtils

java.lang.Object

ca.uhn.fhir.rest.server.RestfulServerUtils

public class RestfulServerUtils
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RestfulServerUtils.ResponseEncoding Return type for determineRequestEncodingNoDefault(RequestDetails)

Constructor Summary

Constructors

Constructor and Description
RestfulServerUtils()

Method Summary

Modifier and Type	Method and Description
static void	addAcceptHeaderToRequest(EncodingEnum theEncoding, IHttpRequest theHttpRequest, FhirContext theContext)
static void	configureResponseParser(RequestDetails theRequestDetails, IParser parser)
static String	createPagingLink(Set<Include> theIncludes, String theServerBase, String theSearchId, int theOffset, int theCount, EncodingEnum theResponseEncoding, boolean thePrettyPrint, BundleTypeEnum theBundleType)
static EncodingEnum	determineRequestEncoding(RequestDetails theReq)
static EncodingEnum	determineRequestEncodingNoDefault(RequestDetails theReq)
static RestfulServerUtils.ResponseEncoding	determineResponseEncodingNoDefault(RequestDetails theReq, EncodingEnum thePrefer) Returns null if the request doesn't express that it wants FHIR.
static RestfulServerUtils.ResponseEncoding	determineResponseEncodingWithDefault(RequestDetails theReq) Determine whether a response should be given in JSON or XML format based on the incoming HttpServletRequest's "_format" parameter and "Accept:" HTTP header.
static Set<SummaryEnum>	determineSummaryMode(RequestDetails theRequest)
static Integer	extractCountParameter(RequestDetails theRequest)
static IPrimitiveType<Date>	extractLastUpdatedFromResource(IBaseResource theResource)
static IIdType	fullyQualifyResourceIdOrReturnNull(IRestfulServerDefaults theServer, IBaseResource theResource, String theServerBase, IIdType theResourceId)
static IParser	getNewParser(FhirContext theContext, RequestDetails theRequestDetails)
static Set<String>	parseAcceptHeaderAndReturnHighestRankedOptions(javax.servlet.http.HttpServletRequest theRequest)
static PreferReturnEnum	parsePreferHeader(String theValue)
static boolean	prettyPrintResponse(IRestfulServerDefaults theServer, RequestDetails theRequest)
static Object	streamResponseAsBundle(IRestfulServerDefaults theServer, Bundle bundle, Set<SummaryEnum> theSummaryMode, boolean respondGzip, RequestDetails theRequestDetails)
static Object	streamResponseAsResource(IRestfulServerDefaults theServer, IBaseResource theResource, Set<SummaryEnum> theSummaryMode, int stausCode, boolean theAddContentLocationHeader, boolean respondGzip, RequestDetails theRequestDetails)
static Object	streamResponseAsResource(IRestfulServerDefaults theServer, IBaseResource theResource, Set<SummaryEnum> theSummaryMode, int theStausCode, String theStatusMessage, boolean theAddContentLocationHeader, boolean respondGzip, RequestDetails theRequestDetails, IIdType theOperationResourceId, IPrimitiveType<Date> theOperationResourceLastUpdated)
static Integer	tryToExtractNamedParameter(RequestDetails theRequest, String theParamName)
static void	validateResourceListNotNull(List<? extends IBaseResource> theResourceList)

Methods inherited from class java.lang.Object

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

Constructor Detail

RestfulServerUtils

public RestfulServerUtils()

Method Detail

configureResponseParser

public static void configureResponseParser(RequestDetails theRequestDetails,
                                           IParser parser)

createPagingLink

public static String createPagingLink(Set<Include> theIncludes,
                                      String theServerBase,
                                      String theSearchId,
                                      int theOffset,
                                      int theCount,
                                      EncodingEnum theResponseEncoding,
                                      boolean thePrettyPrint,
                                      BundleTypeEnum theBundleType)

determineRequestEncoding

public static EncodingEnum determineRequestEncoding(RequestDetails theReq)

determineRequestEncodingNoDefault

public static EncodingEnum determineRequestEncodingNoDefault(RequestDetails theReq)

determineResponseEncodingNoDefault

public static RestfulServerUtils.ResponseEncoding determineResponseEncodingNoDefault(RequestDetails theReq,
                                                                                     EncodingEnum thePrefer)

Returns null if the request doesn't express that it wants FHIR. If it expresses that it wants XML and JSON equally, returns thePrefer.

determineResponseEncodingWithDefault

public static RestfulServerUtils.ResponseEncoding determineResponseEncodingWithDefault(RequestDetails theReq)

Determine whether a response should be given in JSON or XML format based on the incoming HttpServletRequest's "_format" parameter and "Accept:" HTTP header.

determineSummaryMode

public static Set<SummaryEnum> determineSummaryMode(RequestDetails theRequest)

extractCountParameter

public static Integer extractCountParameter(RequestDetails theRequest)

extractLastUpdatedFromResource

public static IPrimitiveType<Date> extractLastUpdatedFromResource(IBaseResource theResource)

fullyQualifyResourceIdOrReturnNull

public static IIdType fullyQualifyResourceIdOrReturnNull(IRestfulServerDefaults theServer,
                                                         IBaseResource theResource,
                                                         String theServerBase,
                                                         IIdType theResourceId)

getNewParser

public static IParser getNewParser(FhirContext theContext,
                                   RequestDetails theRequestDetails)

parseAcceptHeaderAndReturnHighestRankedOptions

public static Set<String> parseAcceptHeaderAndReturnHighestRankedOptions(javax.servlet.http.HttpServletRequest theRequest)

parsePreferHeader

public static PreferReturnEnum parsePreferHeader(String theValue)

prettyPrintResponse

public static boolean prettyPrintResponse(IRestfulServerDefaults theServer,
                                          RequestDetails theRequest)

streamResponseAsBundle

public static Object streamResponseAsBundle(IRestfulServerDefaults theServer,
                                            Bundle bundle,
                                            Set<SummaryEnum> theSummaryMode,
                                            boolean respondGzip,
                                            RequestDetails theRequestDetails)
                                     throws IOException

Throws:

IOException

streamResponseAsResource

public static Object streamResponseAsResource(IRestfulServerDefaults theServer,
                                              IBaseResource theResource,
                                              Set<SummaryEnum> theSummaryMode,
                                              int stausCode,
                                              boolean theAddContentLocationHeader,
                                              boolean respondGzip,
                                              RequestDetails theRequestDetails)
                                       throws IOException

Throws:

IOException

streamResponseAsResource

public static Object streamResponseAsResource(IRestfulServerDefaults theServer,
                                              IBaseResource theResource,
                                              Set<SummaryEnum> theSummaryMode,
                                              int theStausCode,
                                              String theStatusMessage,
                                              boolean theAddContentLocationHeader,
                                              boolean respondGzip,
                                              RequestDetails theRequestDetails,
                                              IIdType theOperationResourceId,
                                              IPrimitiveType<Date> theOperationResourceLastUpdated)
                                       throws IOException

Throws:

IOException

tryToExtractNamedParameter

public static Integer tryToExtractNamedParameter(RequestDetails theRequest,
                                                 String theParamName)

validateResourceListNotNull

public static void validateResourceListNotNull(List<? extends IBaseResource> theResourceList)

addAcceptHeaderToRequest

public static void addAcceptHeaderToRequest(EncodingEnum theEncoding,
                                            IHttpRequest theHttpRequest,
                                            FhirContext theContext)