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

Class UpdateMethodBinding

java.lang.Object

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

ca.uhn.fhir.rest.server.method.UpdateMethodBinding

public class UpdateMethodBinding
extends BaseMethodBinding

Constructor Summary

Constructors

Constructor	Description
UpdateMethodBinding(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. delete)
static org.hl7.fhir.instance.model.api.IIdType	applyETagAsVersion(RequestDetails theRequest, org.hl7.fhir.instance.model.api.IIdType theId)
static org.hl7.fhir.instance.model.api.IIdType	applyETagAsVersion(String theIfMatchValue, org.hl7.fhir.instance.model.api.IIdType theId)
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.
String	getResourceName()	Returns the name of the resource this method handles, or null if this method is not resource specific
ca.uhn.fhir.rest.api.RestOperationTypeEnum	getRestOperationType()
MethodMatchEnum	incomingServerRequestMatchesMethod(RequestDetails theRequest)
Object	invokeServer(IRestfulServer<?> theServer, RequestDetails theRequest)
boolean	isReturnVoid()
protected void	populateRequestDetailsForInterceptor(RequestDetails theRequestDetails, Object[] theMethodParams)	Subclasses may override this method (but should also call super) to provide method specifics to the interceptors.
protected Set<ca.uhn.fhir.rest.api.RequestTypeEnum>	provideAllowableRequestTypes()
protected void	validateResourceIdAndUrlIdForNonConditionalOperation(org.hl7.fhir.instance.model.api.IBaseResource theResource, String theResourceId, String theUrlId, String theMatchUrl)	Subclasses may override

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

UpdateMethodBinding

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

Method Details

addParametersForServerRequest

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

applyETagAsVersion

public static org.hl7.fhir.instance.model.api.IIdType applyETagAsVersion(RequestDetails theRequest,
 org.hl7.fhir.instance.model.api.IIdType theId)

applyETagAsVersion

public static org.hl7.fhir.instance.model.api.IIdType applyETagAsVersion(String theIfMatchValue,
 org.hl7.fhir.instance.model.api.IIdType theId)

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.

getRestOperationType

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

Specified by:

getRestOperationType in class BaseMethodBinding

provideAllowableRequestTypes

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

validateResourceIdAndUrlIdForNonConditionalOperation

protected void validateResourceIdAndUrlIdForNonConditionalOperation(org.hl7.fhir.instance.model.api.IBaseResource theResource,
 String theResourceId,
 String theUrlId,
 String theMatchUrl)

Subclasses may override

getResourceName

public String getResourceName()

Description copied from class: BaseMethodBinding

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

Specified by:

getResourceName in class BaseMethodBinding

populateRequestDetailsForInterceptor

protected void populateRequestDetailsForInterceptor(RequestDetails theRequestDetails,
 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:

populateRequestDetailsForInterceptor in class BaseMethodBinding

Parameters:

theRequestDetails - The server request details

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

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 MethodMatchEnum incomingServerRequestMatchesMethod(RequestDetails theRequest)

Specified by:

incomingServerRequestMatchesMethod in class BaseMethodBinding

invokeServer

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

Specified by:

invokeServer in class BaseMethodBinding

Throws:

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

IOException

isReturnVoid

public boolean isReturnVoid()