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

Class BaseMethodBinding

java.lang.Object

ca.uhn.fhir.rest.server.method.BaseMethodBinding

Direct Known Subclasses:

BaseOutcomeReturningMethodBindingWithResourceIdButNoResourceBody, BaseResourceReturningMethodBinding, CreateMethodBinding, UpdateMethodBinding

public abstract class BaseMethodBinding
extends Object

Constructor Summary

Constructors

Constructor	Description
BaseMethodBinding(Method theMethod, ca.uhn.fhir.context.FhirContext theContext, Object theProvider)

Method Summary

Modifier and Type	Method	Description
static BaseMethodBinding	bindMethod(Method theMethod, ca.uhn.fhir.context.FhirContext theContext, Object theProvider)
void	close()
protected Object[]	createMethodParams(RequestDetails theRequest)
protected Object[]	createParametersForServerRequest(RequestDetails theRequest)
List<Class<?>>	getAllowableParamAnnotations()
ca.uhn.fhir.context.FhirContext	getContext()
Set<String>	getIncludes()
Method	getMethod()
List<IParameter>	getParameters()
Object	getProvider()
protected List<BaseQueryParameter>	getQueryParameters()
Set<ca.uhn.fhir.model.api.Include>	getRequestIncludesFromParams(Object[] params)
abstract String	getResourceName()	Returns the name of the resource this method handles, or null if this method is not resource specific
abstract 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
Set<String>	getRevIncludes()
abstract MethodMatchEnum	incomingServerRequestMatchesMethod(RequestDetails theRequest)
abstract Object	invokeServer(IRestfulServer<?> theServer, RequestDetails theRequest)
protected final Object	invokeServerMethod(RequestDetails theRequest, Object[] theMethodParams)
boolean	isGlobalMethod()	Subclasses may override to declare that they apply to all resource types
boolean	isSupportsConditional()	Does this method have a parameter annotated with ConditionalParamBinder.
boolean	isSupportsConditionalMultiple()	Does this method support conditional operations over multiple objects (basically for conditional delete)
protected void	populateRequestDetailsForInterceptor(RequestDetails theRequestDetails, Object[] theMethodParams)	Subclasses may override this method (but should also call super) to provide method specifics to the interceptors.
void	setParameters(List<IParameter> theParameters)	For unit tests only
protected IBundleProvider	toResourceList(Object response)
static boolean	verifyMethodHasZeroOrOneOperationAnnotation(Method theNextMethod, Object... theAnnotations)

Methods inherited from class java.lang.Object

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

Constructor Details

BaseMethodBinding

public BaseMethodBinding(Method theMethod,
 ca.uhn.fhir.context.FhirContext theContext,
 Object theProvider)

Method Details

getQueryParameters

protected List<BaseQueryParameter> getQueryParameters()

createMethodParams

protected Object[] createMethodParams(RequestDetails theRequest)

createParametersForServerRequest

protected Object[] createParametersForServerRequest(RequestDetails theRequest)

isGlobalMethod

public boolean isGlobalMethod()

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

getAllowableParamAnnotations

public List<Class<?>> getAllowableParamAnnotations()

getContext

public ca.uhn.fhir.context.FhirContext getContext()

getIncludes

public Set<String> getIncludes()

getRevIncludes

public Set<String> getRevIncludes()

getMethod

public Method getMethod()

getParameters

public List<IParameter> getParameters()

setParameters

public void setParameters(List<IParameter> theParameters)

For unit tests only

getProvider

public Object getProvider()

getRequestIncludesFromParams

public Set<ca.uhn.fhir.model.api.Include> getRequestIncludesFromParams(Object[] params)

getResourceName

public abstract String getResourceName()

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

getRestOperationType

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

getRestOperationType

public ca.uhn.fhir.rest.api.RestOperationTypeEnum getRestOperationType(RequestDetails theRequestDetails)

Determine which operation is being fired for a specific request

Parameters:

theRequestDetails - The request

incomingServerRequestMatchesMethod

public abstract MethodMatchEnum incomingServerRequestMatchesMethod(RequestDetails theRequest)

invokeServer

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

Throws:

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

IOException

invokeServerMethod

protected final Object invokeServerMethod(RequestDetails theRequest,
 Object[] theMethodParams)

isSupportsConditional

public boolean isSupportsConditional()

Does this method have a parameter annotated with ConditionalParamBinder. Note that many operations don't actually support this paramter, so this will only return true occasionally.

isSupportsConditionalMultiple

public boolean isSupportsConditionalMultiple()

Does this method support conditional operations over multiple objects (basically for conditional delete)

populateRequestDetailsForInterceptor

protected void populateRequestDetailsForInterceptor(RequestDetails theRequestDetails,
 Object[] theMethodParams)

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

Parameters:

theRequestDetails - The server request details

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

toResourceList

protected IBundleProvider toResourceList(Object response)
                                  throws ca.uhn.fhir.rest.server.exceptions.InternalErrorException

Throws:

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

close

public void close()

bindMethod

public static BaseMethodBinding bindMethod(Method theMethod,
 ca.uhn.fhir.context.FhirContext theContext,
 Object theProvider)

verifyMethodHasZeroOrOneOperationAnnotation

public static boolean verifyMethodHasZeroOrOneOperationAnnotation(Method theNextMethod,
 Object... theAnnotations)