ca.uhn.fhir.rest.method

Class BaseResourceReturningMethodBinding

java.lang.Object

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

ca.uhn.fhir.rest.method.BaseResourceReturningMethodBinding

All Implemented Interfaces:

IClientResponseHandler<Object>

Direct Known Subclasses:

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

public abstract class BaseResourceReturningMethodBinding
extends BaseMethodBinding<Object>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BaseResourceReturningMethodBinding.MethodReturnTypeEnum
static class	BaseResourceReturningMethodBinding.ResourceOrDstu1Bundle
static class	BaseResourceReturningMethodBinding.ReturnTypeEnum

Nested classes/interfaces inherited from class ca.uhn.fhir.rest.method.BaseMethodBinding

BaseMethodBinding.ActiveRequestReader, BaseMethodBinding.InactiveRequestReader, BaseMethodBinding.IRequestReader

Field Summary

Fields

Modifier and Type	Field and Description
protected static Set<String>	ALLOWED_PARAMS

Constructor Summary

Constructors

Constructor and Description
BaseResourceReturningMethodBinding(Class<?> theReturnResourceType, Method theMethod, FhirContext theContext, Object theProvider)

Method Summary

Modifier and Type	Method and Description
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 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	invokeClient(String theResponseMimeType, Reader theResponseReader, int theResponseStatusCode, Map<String,List<String>> theHeaders)
Object	invokeServer(IRestfulServer<?> theServer, RequestDetails theRequest)
BaseResourceReturningMethodBinding.ResourceOrDstu1Bundle	invokeServer(IRestfulServer<?> theServer, RequestDetails theRequest, byte[] requestContents)
abstract Object	invokeServer(IRestfulServer<?> theServer, RequestDetails theRequest, Object[] theMethodParams)
protected boolean	isAddContentLocationHeader() Should the response include a Content-Location header.
protected void	setResourceName(String theResourceName)

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

bindMethod, createAppropriateParserForParsingResponse, createAppropriateParserForParsingServerRequest, createParametersForServerRequest, getAllowableParamAnnotations, getContext, getIncludes, getMethod, getParameters, getProvider, getRequestIncludesFromParams, getRestOperationType, getRestOperationType, incomingServerRequestMatchesMethod, invokeClient, invokeServerMethod, isSupportsConditional, isSupportsConditionalMultiple, populateActionRequestDetailsForInterceptor, processNon2xxResponseAndReturnExceptionToThrow, setParameters, toResourceList, verifyMethodHasZeroOrOneOperationAnnotation

Methods inherited from class java.lang.Object

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

Field Detail

ALLOWED_PARAMS

protected static final Set<String> ALLOWED_PARAMS

Constructor Detail

BaseResourceReturningMethodBinding

public BaseResourceReturningMethodBinding(Class<?> theReturnResourceType,
                                          Method theMethod,
                                          FhirContext theContext,
                                          Object theProvider)

Method Detail

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>

getResponseBundleType

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

invokeClient

public Object invokeClient(String theResponseMimeType,
                           Reader theResponseReader,
                           int theResponseStatusCode,
                           Map<String,List<String>> theHeaders)

invokeServer

public Object invokeServer(IRestfulServer<?> theServer,
                           RequestDetails theRequest)
                    throws BaseServerResponseException,
                           IOException

Specified by:

invokeServer in class BaseMethodBinding<Object>

Throws:

BaseServerResponseException

IOException

invokeServer

public BaseResourceReturningMethodBinding.ResourceOrDstu1Bundle invokeServer(IRestfulServer<?> theServer,
                                                                             RequestDetails theRequest,
                                                                             byte[] requestContents)

invokeServer

public abstract Object invokeServer(IRestfulServer<?> theServer,
                                    RequestDetails theRequest,
                                    Object[] theMethodParams)
                             throws InvalidRequestException,
                                    InternalErrorException

Throws:

InvalidRequestException

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

setResourceName

protected void setResourceName(String theResourceName)