Package ca.uhn.fhir.rest.server.method

Class BaseResourceReturningMethodBinding

java.lang.Object

ca.uhn.fhir.rest.server.method.BaseMethodBinding<Object>

ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding

Direct Known Subclasses:

ConformanceMethodBinding, HistoryMethodBinding, OperationMethodBinding, PageMethodBinding, ReadMethodBinding, SearchMethodBinding, TransactionMethodBinding

public abstract class BaseResourceReturningMethodBinding
extends BaseMethodBinding<Object>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BaseResourceReturningMethodBinding.MethodReturnTypeEnum
static enum	BaseResourceReturningMethodBinding.ReturnTypeEnum

Constructor Summary

Constructors

Constructor	Description
BaseResourceReturningMethodBinding(Class<?> theReturnResourceType, Method theMethod, ca.uhn.fhir.context.FhirContext theContext, Object theProvider)

Method Summary

Modifier and Type	Method	Description
static void	callOutgoingFailureOperationOutcomeHook(RequestDetails theRequestDetails, org.hl7.fhir.instance.model.api.IBaseOperationOutcome theOperationOutcome)
static boolean	callOutgoingResponseHook(RequestDetails theRequest, ResponseDetails theResponseDetails)
org.hl7.fhir.instance.model.api.IBaseResource	doInvokeServer(IRestfulServer<?> theServer, RequestDetails theRequest)
BaseResourceReturningMethodBinding.MethodReturnTypeEnum	getMethodReturnType()
String	getResourceName()	Returns the name of the resource this method handles, or null if this method is not resource specific
protected abstract ca.uhn.fhir.model.valueset.BundleTypeEnum	getResponseBundleType()	If the response is a bundle, this type will be placed in the root of the bundle (can be null)
abstract BaseResourceReturningMethodBinding.ReturnTypeEnum	getReturnType()
Object	invokeServer(IRestfulServer<?> theServer, RequestDetails theRequest)
abstract Object	invokeServer(IRestfulServer<?> theServer, RequestDetails theRequest, Object[] theMethodParams)
protected boolean	isAddContentLocationHeader()	Should the response include a Content-Location header.
protected boolean	isOffsetModeHistory()
protected Set<Class<?>>	provideExpectedReturnTypes()	Subclasses may override
protected void	setResourceName(String theResourceName)

Methods inherited from class ca.uhn.fhir.rest.server.method.BaseMethodBinding

bindMethod, close, createMethodParams, createParametersForServerRequest, getAllowableParamAnnotations, getContext, getIncludes, getMethod, getParameters, getProvider, getQueryParameters, getRequestIncludesFromParams, getRestOperationType, getRestOperationType, getRevIncludes, incomingServerRequestMatchesMethod, invokeServerMethod, isGlobalMethod, isSupportsConditional, isSupportsConditionalMultiple, populateActionRequestDetailsForInterceptor, setParameters, toResourceList, verifyMethodHasZeroOrOneOperationAnnotation

Methods inherited from class java.lang.Object

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

Constructor Details

BaseResourceReturningMethodBinding

public BaseResourceReturningMethodBinding(Class<?> theReturnResourceType,
 Method theMethod,
 ca.uhn.fhir.context.FhirContext theContext,
 Object theProvider)

Method Details

provideExpectedReturnTypes

protected Set<Class<?>> provideExpectedReturnTypes()

Subclasses may override

isOffsetModeHistory

protected boolean isOffsetModeHistory()

doInvokeServer

public org.hl7.fhir.instance.model.api.IBaseResource doInvokeServer(IRestfulServer<?> theServer,
 RequestDetails theRequest)

getMethodReturnType

public BaseResourceReturningMethodBinding.MethodReturnTypeEnum getMethodReturnType()

getResourceName

public String getResourceName()

Description copied from class: BaseMethodBinding

Returns the name of the resource this method handles, or null if this method is not resource specific

Specified by:

getResourceName in class BaseMethodBinding<Object>

setResourceName

protected void setResourceName(String theResourceName)

getResponseBundleType

protected abstract ca.uhn.fhir.model.valueset.BundleTypeEnum getResponseBundleType()

If the response is a bundle, this type will be placed in the root of the bundle (can be null)

getReturnType

public abstract BaseResourceReturningMethodBinding.ReturnTypeEnum getReturnType()

invokeServer

public Object invokeServer(IRestfulServer<?> theServer,
 RequestDetails theRequest)
                    throws ca.uhn.fhir.rest.server.exceptions.BaseServerResponseException,
IOException

Specified by:

invokeServer in class BaseMethodBinding<Object>

Throws:

ca.uhn.fhir.rest.server.exceptions.BaseServerResponseException

IOException

invokeServer

public abstract Object invokeServer(IRestfulServer<?> theServer,
 RequestDetails theRequest,
 Object[] theMethodParams)
                             throws ca.uhn.fhir.rest.server.exceptions.InvalidRequestException,
ca.uhn.fhir.rest.server.exceptions.InternalErrorException

Throws:

ca.uhn.fhir.rest.server.exceptions.InvalidRequestException

ca.uhn.fhir.rest.server.exceptions.InternalErrorException

isAddContentLocationHeader

protected boolean isAddContentLocationHeader()

Should the response include a Content-Location header. Search method bunding (and any others?) may override this to disable the content-location, since it doesn't make sense

callOutgoingResponseHook

public static boolean callOutgoingResponseHook(RequestDetails theRequest,
 ResponseDetails theResponseDetails)

callOutgoingFailureOperationOutcomeHook

public static void callOutgoingFailureOperationOutcomeHook(RequestDetails theRequestDetails,
 org.hl7.fhir.instance.model.api.IBaseOperationOutcome theOperationOutcome)