ca.uhn.fhir.rest.method

Class OperationMethodBinding

java.lang.Object

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

ca.uhn.fhir.rest.method.BaseResourceReturningMethodBinding

ca.uhn.fhir.rest.method.OperationMethodBinding

All Implemented Interfaces:

IClientResponseHandler<Object>

Direct Known Subclasses:

ValidateMethodBindingDstu2

public class OperationMethodBinding
extends BaseResourceReturningMethodBinding

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OperationMethodBinding.ReturnType

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

Modifier	Constructor and Description
protected	OperationMethodBinding(Class<?> theReturnResourceType, Class<? extends IBaseResource> theReturnTypeFromRp, Method theMethod, FhirContext theContext, Object theProvider, boolean theIdempotent, String theOperationName, Class<? extends IBaseResource> theOperationType, OperationParam[] theReturnParams)
	OperationMethodBinding(Class<?> theReturnResourceType, Class<? extends IBaseResource> theReturnTypeFromRp, Method theMethod, FhirContext theContext, Object theProvider, Operation theAnnotation)

Method Summary

Modifier and Type	Method and Description
static BaseHttpClientInvocation	createOperationInvocation(FhirContext theContext, String theResourceName, String theId, String theOperationName, IBaseParameters theInput, boolean theUseHttpGet)
String	getDescription()
String	getName() Returns the name of the operation, starting with "$"
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()
List<OperationMethodBinding.ReturnType>	getReturnParams()
BaseResourceReturningMethodBinding.ReturnTypeEnum	getReturnType()
boolean	incomingServerRequestMatchesMethod(RequestDetails theRequest)
BaseHttpClientInvocation	invokeClient(Object[] theArgs)
Object	invokeServer(IRestfulServer theServer, RequestDetails theRequest, Object[] theMethodParams)
boolean	isCanOperateAtInstanceLevel()
boolean	isCanOperateAtServerLevel()
boolean	isIdempotent()
void	setDescription(String theDescription)

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, getAllowableParamAnnotations, getContext, getIncludes, getMethod, getParameters, getProvider, getRequestIncludesFromParams, getRestOperationType, 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

Constructor Detail

OperationMethodBinding

protected OperationMethodBinding(Class<?> theReturnResourceType,
                                 Class<? extends IBaseResource> theReturnTypeFromRp,
                                 Method theMethod,
                                 FhirContext theContext,
                                 Object theProvider,
                                 boolean theIdempotent,
                                 String theOperationName,
                                 Class<? extends IBaseResource> theOperationType,
                                 OperationParam[] theReturnParams)

OperationMethodBinding

public OperationMethodBinding(Class<?> theReturnResourceType,
                              Class<? extends IBaseResource> theReturnTypeFromRp,
                              Method theMethod,
                              FhirContext theContext,
                              Object theProvider,
                              Operation theAnnotation)

Method Detail

getDescription

public String getDescription()

getName

public String getName()

Returns the name of the operation, starting with "$"

getRestOperationType

public RestOperationTypeEnum getRestOperationType()

Specified by:

getRestOperationType in class BaseMethodBinding<Object>

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

getReturnParams

public List<OperationMethodBinding.ReturnType> getReturnParams()

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 BaseHttpClientInvocation invokeClient(Object[] theArgs)
                                      throws InternalErrorException

Specified by:

invokeClient in class BaseMethodBinding<Object>

Throws:

InternalErrorException

invokeServer

public Object invokeServer(IRestfulServer theServer,
                           RequestDetails theRequest,
                           Object[] theMethodParams)
                    throws BaseServerResponseException

Specified by:

invokeServer in class BaseResourceReturningMethodBinding

Throws:

BaseServerResponseException

isCanOperateAtInstanceLevel

public boolean isCanOperateAtInstanceLevel()

isCanOperateAtServerLevel

public boolean isCanOperateAtServerLevel()

isIdempotent

public boolean isIdempotent()

setDescription

public void setDescription(String theDescription)

createOperationInvocation

public static BaseHttpClientInvocation createOperationInvocation(FhirContext theContext,
                                                                 String theResourceName,
                                                                 String theId,
                                                                 String theOperationName,
                                                                 IBaseParameters theInput,
                                                                 boolean theUseHttpGet)