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

Class PatchMethodBinding

java.lang.Object

ca.uhn.fhir.rest.server.method.BaseMethodBinding<ca.uhn.fhir.rest.api.MethodOutcome>

ca.uhn.fhir.rest.server.method.BaseOutcomeReturningMethodBindingWithResourceIdButNoResourceBody

ca.uhn.fhir.rest.server.method.PatchMethodBinding

public class PatchMethodBinding
extends BaseOutcomeReturningMethodBindingWithResourceIdButNoResourceBody

Base class for an operation that has a resource type but not a resource body in the request body

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
protected void	addParametersForServerRequest(RequestDetails theRequest, Object[] theParams)
protected boolean	allowVoidReturnType()	Subclasses may override to allow a void method return type, which is allowable for some methods (e.g.
protected String	getMatchingOperation()	For servers, this method will match only incoming requests that match the given operation, or which have no operation in the URL if this method returns null.
ca.uhn.fhir.rest.api.RestOperationTypeEnum	getRestOperationType()
boolean	incomingServerRequestMatchesMethod(RequestDetails theRequest)
Object	invokeServer(IRestfulServer<?> theServer, RequestDetails theRequest)
boolean	isReturnVoid()
protected Set<ca.uhn.fhir.rest.api.RequestTypeEnum>	provideAllowableRequestTypes()

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

getIdParameterIndex, getResourceName

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

bindMethod, createMethodParams, createParametersForServerRequest, getAllowableParamAnnotations, getContext, getIncludes, getMethod, getParameters, getProvider, getRequestIncludesFromParams, getRestOperationType, invokeServerMethod, isGlobalMethod, isSupportsConditional, isSupportsConditionalMultiple, populateActionRequestDetailsForInterceptor, setParameters, toResourceList, verifyMethodHasZeroOrOneOperationAnnotation

Methods inherited from class java.lang.Object

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

Constructor Detail

PatchMethodBinding

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

Method Detail

allowVoidReturnType

protected boolean allowVoidReturnType()

Subclasses may override to allow a void method return type, which is allowable for some methods (e.g. delete)

incomingServerRequestMatchesMethod

public boolean incomingServerRequestMatchesMethod(RequestDetails theRequest)

getRestOperationType

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

Specified by:

getRestOperationType in class BaseMethodBinding<ca.uhn.fhir.rest.api.MethodOutcome>

provideAllowableRequestTypes

protected Set<ca.uhn.fhir.rest.api.RequestTypeEnum> provideAllowableRequestTypes()

addParametersForServerRequest

protected void addParametersForServerRequest(RequestDetails theRequest,
                                             Object[] theParams)

getMatchingOperation

protected String getMatchingOperation()

For servers, this method will match only incoming requests that match the given operation, or which have no operation in the URL if this method returns null.

invokeServer

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

Specified by:

invokeServer in class BaseMethodBinding<ca.uhn.fhir.rest.api.MethodOutcome>

Throws:

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

IOException

isReturnVoid

public boolean isReturnVoid()