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

Class OperationMethodBinding

java.lang.Object

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

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

ca.uhn.fhir.rest.server.method.OperationMethodBinding

Direct Known Subclasses:

GraphQLMethodBinding, ValidateMethodBindingDstu2Plus

public class OperationMethodBinding
extends BaseResourceReturningMethodBinding

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	OperationMethodBinding.ReturnType

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

BaseResourceReturningMethodBinding.MethodReturnTypeEnum, BaseResourceReturningMethodBinding.ReturnTypeEnum

Field Summary

Fields

Modifier and Type	Field	Description
static String	WILDCARD_NAME

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	OperationMethodBinding(Class<?> theReturnResourceType, Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theReturnTypeFromRp, Method theMethod, ca.uhn.fhir.context.FhirContext theContext, Object theProvider, boolean theIdempotent, String theOperationName, Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theOperationType, String theOperationTypeName, ca.uhn.fhir.rest.annotation.OperationParam[] theReturnParams, ca.uhn.fhir.model.valueset.BundleTypeEnum theBundleType, boolean theGlobal)
	OperationMethodBinding(Class<?> theReturnResourceType, Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theReturnTypeFromRp, Method theMethod, ca.uhn.fhir.context.FhirContext theContext, Object theProvider, ca.uhn.fhir.rest.annotation.Operation theAnnotation)	Constructor - This is the constructor that is called when binding a standard @Operation method.

Method Summary

Modifier and Type	Method	Description
String	getDescription()
String	getName()	Returns the name of the operation, starting with "$"
protected 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)
ca.uhn.fhir.rest.api.RestOperationTypeEnum	getRestOperationType()
ca.uhn.fhir.rest.api.RestOperationTypeEnum	getRestOperationType(RequestDetails theRequestDetails)	Determine which operation is being fired for a specific request
List<OperationMethodBinding.ReturnType>	getReturnParams()
BaseResourceReturningMethodBinding.ReturnTypeEnum	getReturnType()
String	getShortDescription()
MethodMatchEnum	incomingServerRequestMatchesMethod(RequestDetails theRequest)
Object	invokeServer(IRestfulServer<?> theServer, RequestDetails theRequest)
Object	invokeServer(IRestfulServer<?> theServer, RequestDetails theRequest, Object[] theMethodParams)
boolean	isCanOperateAtInstanceLevel()
boolean	isCanOperateAtServerLevel()
boolean	isCanOperateAtTypeLevel()
boolean	isGlobalMethod()	Subclasses may override to declare that they apply to all resource types
boolean	isIdempotent()
boolean	isManualRequestMode()
protected void	populateActionRequestDetailsForInterceptor(RequestDetails theRequestDetails, IServerInterceptor.ActionRequestDetails theDetails, Object[] theMethodParams)	Subclasses may override this method (but should also call super) to provide method specifics to the interceptors.
void	setDescription(String theDescription)
String	toString()

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

callOutgoingFailureOperationOutcomeHook, callOutgoingResponseHook, doInvokeServer, getMethodReturnType, getResourceName, isAddContentLocationHeader, isOffsetModeHistory, provideExpectedReturnTypes, setResourceName

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

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

Methods inherited from class java.lang.Object

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

Field Details

WILDCARD_NAME

public static final String WILDCARD_NAME

See Also:

Constant Field Values

Constructor Details

OperationMethodBinding

public OperationMethodBinding(Class<?> theReturnResourceType,
 Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theReturnTypeFromRp,
 Method theMethod,
 ca.uhn.fhir.context.FhirContext theContext,
 Object theProvider,
 ca.uhn.fhir.rest.annotation.Operation theAnnotation)

Constructor - This is the constructor that is called when binding a standard @Operation method.

OperationMethodBinding

protected OperationMethodBinding(Class<?> theReturnResourceType,
 Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theReturnTypeFromRp,
 Method theMethod,
 ca.uhn.fhir.context.FhirContext theContext,
 Object theProvider,
 boolean theIdempotent,
 String theOperationName,
 Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theOperationType,
 String theOperationTypeName,
 ca.uhn.fhir.rest.annotation.OperationParam[] theReturnParams,
 ca.uhn.fhir.model.valueset.BundleTypeEnum theBundleType,
 boolean theGlobal)

Method Details

getShortDescription

public String getShortDescription()

isGlobalMethod

public boolean isGlobalMethod()

Description copied from class: BaseMethodBinding

Subclasses may override to declare that they apply to all resource types

Overrides:

isGlobalMethod in class BaseMethodBinding<Object>

getDescription

public String getDescription()

setDescription

public void setDescription(String theDescription)

getName

public String getName()

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

getResponseBundleType

protected ca.uhn.fhir.model.valueset.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

getRestOperationType

@Nonnull
public ca.uhn.fhir.rest.api.RestOperationTypeEnum getRestOperationType()

Specified by:

getRestOperationType in class BaseMethodBinding<Object>

getReturnParams

public List<OperationMethodBinding.ReturnType> getReturnParams()

getReturnType

public BaseResourceReturningMethodBinding.ReturnTypeEnum getReturnType()

Specified by:

getReturnType in class BaseResourceReturningMethodBinding

incomingServerRequestMatchesMethod

public MethodMatchEnum incomingServerRequestMatchesMethod(RequestDetails theRequest)

Specified by:

incomingServerRequestMatchesMethod in class BaseMethodBinding<Object>

getRestOperationType

public ca.uhn.fhir.rest.api.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

toString

public String toString()

Overrides:

toString in class Object

invokeServer

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

Overrides:

invokeServer in class BaseResourceReturningMethodBinding

Throws:

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

IOException

invokeServer

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

Specified by:

invokeServer in class BaseResourceReturningMethodBinding

Throws:

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

isCanOperateAtInstanceLevel

public boolean isCanOperateAtInstanceLevel()

isCanOperateAtServerLevel

public boolean isCanOperateAtServerLevel()

isCanOperateAtTypeLevel

public boolean isCanOperateAtTypeLevel()

isIdempotent

public boolean isIdempotent()

populateActionRequestDetailsForInterceptor

protected void populateActionRequestDetailsForInterceptor(RequestDetails theRequestDetails,
 IServerInterceptor.ActionRequestDetails theDetails,
 Object[] theMethodParams)

Description copied from class: BaseMethodBinding

Subclasses may override this method (but should also call super) to provide method specifics to the interceptors.

Overrides:

populateActionRequestDetailsForInterceptor in class BaseMethodBinding<Object>

Parameters:

theRequestDetails - The server request details

theDetails - The details object to populate

theMethodParams - The method params as generated by the specific method binding

isManualRequestMode

public boolean isManualRequestMode()