ca.uhn.fhir.rest.method

Class ReadMethodBinding

java.lang.Object

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

ca.uhn.fhir.rest.method.BaseResourceReturningMethodBinding

ca.uhn.fhir.rest.method.ReadMethodBinding

All Implemented Interfaces:

IClientResponseHandler<Object>, IClientResponseHandlerHandlesBinary<Object>

public class ReadMethodBinding
extends BaseResourceReturningMethodBinding
implements IClientResponseHandlerHandlesBinary<Object>

Nested Class Summary

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

BaseResourceReturningMethodBinding.MethodReturnTypeEnum, BaseResourceReturningMethodBinding.ResourceOrDstu1Bundle, BaseResourceReturningMethodBinding.ReturnTypeEnum

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

BaseMethodBinding.ActiveRequestReader, BaseMethodBinding.InactiveRequestReader, BaseMethodBinding.IRequestReader

Field Summary

Fields inherited from class ca.uhn.fhir.rest.method.BaseResourceReturningMethodBinding

ALLOWED_PARAMS

Constructor Summary

Constructors

Constructor and Description
ReadMethodBinding(Class<? extends IBaseResource> theAnnotatedResourceType, Method theMethod, FhirContext theContext, Object theProvider)

Method Summary

Modifier and Type	Method and Description
static HttpGetClientInvocation	createAbsoluteReadInvocation(IIdType theId)
static HttpGetClientInvocation	createAbsoluteVReadInvocation(IIdType theId)
static HttpGetClientInvocation	createReadInvocation(IIdType theId, String theResourceName)
static HttpGetClientInvocation	createVReadInvocation(IIdType theId, String theResourceName)
List<Class<?>>	getAllowableParamAnnotations()
protected BundleTypeEnum	getResponseBundleType() If the response is a bundle, this type will be placed in the root of the bundle (can be null)
RestOperationTypeEnum	getRestOperationType()
RestOperationTypeEnum	getRestOperationType(RequestDetails theRequestDetails) Determine which operation is being fired for a specific request
BaseResourceReturningMethodBinding.ReturnTypeEnum	getReturnType()
boolean	incomingServerRequestMatchesMethod(RequestDetails theRequest)
HttpGetClientInvocation	invokeClient(Object[] theArgs)
Object	invokeClient(String theResponseMimeType, InputStream theResponseReader, int theResponseStatusCode, Map<String,List<String>> theHeaders)
IBundleProvider	invokeServer(IRestfulServer<?> theServer, RequestDetails theRequest, Object[] theMethodParams)
boolean	isBinary() If this method returns true, IClientResponseHandlerHandlesBinary.invokeClient(String, InputStream, int, Map) should be invoked instead of IClientResponseHandler.invokeClient(String, Reader, int, Map)
boolean	isVread()

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

getMethodReturnType, getResourceName, invokeClient, invokeServer, invokeServer, isAddContentLocationHeader, setResourceName

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

bindMethod, createAppropriateParserForParsingResponse, createAppropriateParserForParsingServerRequest, createParametersForServerRequest, getContext, getIncludes, getMethod, getParameters, getProvider, getRequestIncludesFromParams, 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

Methods inherited from interface ca.uhn.fhir.rest.method.IClientResponseHandler

invokeClient

Constructor Detail

ReadMethodBinding

public ReadMethodBinding(Class<? extends IBaseResource> theAnnotatedResourceType,
                         Method theMethod,
                         FhirContext theContext,
                         Object theProvider)

Method Detail

getRestOperationType

public RestOperationTypeEnum getRestOperationType(RequestDetails theRequestDetails)

Description copied from class: BaseMethodBinding

Determine which operation is being fired for a specific request

Overrides:

getRestOperationType in class BaseMethodBinding<Object>

Parameters:

theRequestDetails - The request

getAllowableParamAnnotations

public List<Class<?>> getAllowableParamAnnotations()

Overrides:

getAllowableParamAnnotations in class BaseMethodBinding<Object>

getRestOperationType

public RestOperationTypeEnum getRestOperationType()

Specified by:

getRestOperationType in class BaseMethodBinding<Object>

getReturnType

public BaseResourceReturningMethodBinding.ReturnTypeEnum getReturnType()

Specified by:

getReturnType in class BaseResourceReturningMethodBinding

incomingServerRequestMatchesMethod

public boolean incomingServerRequestMatchesMethod(RequestDetails theRequest)

Specified by:

incomingServerRequestMatchesMethod in class BaseMethodBinding<Object>

invokeClient

public HttpGetClientInvocation invokeClient(Object[] theArgs)

Specified by:

invokeClient in class BaseMethodBinding<Object>

invokeClient

public Object invokeClient(String theResponseMimeType,
                           InputStream theResponseReader,
                           int theResponseStatusCode,
                           Map<String,List<String>> theHeaders)
                    throws IOException,
                           BaseServerResponseException

Specified by:

invokeClient in interface IClientResponseHandlerHandlesBinary<Object>

Throws:

IOException

BaseServerResponseException

invokeServer

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

Specified by:

invokeServer in class BaseResourceReturningMethodBinding

Throws:

InvalidRequestException

InternalErrorException

isBinary

public boolean isBinary()

Description copied from interface: IClientResponseHandlerHandlesBinary

If this method returns true, IClientResponseHandlerHandlesBinary.invokeClient(String, InputStream, int, Map) should be invoked instead of IClientResponseHandler.invokeClient(String, Reader, int, Map)

Specified by:

isBinary in interface IClientResponseHandlerHandlesBinary<Object>

isVread

public boolean isVread()

createAbsoluteReadInvocation

public static HttpGetClientInvocation createAbsoluteReadInvocation(IIdType theId)

createAbsoluteVReadInvocation

public static HttpGetClientInvocation createAbsoluteVReadInvocation(IIdType theId)

createReadInvocation

public static HttpGetClientInvocation createReadInvocation(IIdType theId,
                                                           String theResourceName)

createVReadInvocation

public static HttpGetClientInvocation createVReadInvocation(IIdType theId,
                                                            String theResourceName)

getResponseBundleType

protected BundleTypeEnum getResponseBundleType()

Description copied from class: BaseResourceReturningMethodBinding

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

Specified by:

getResponseBundleType in class BaseResourceReturningMethodBinding