ca.uhn.fhir.rest.server.method

Class CreateMethodBinding

java.lang.Object

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

ca.uhn.fhir.rest.server.method.CreateMethodBinding

public class CreateMethodBinding
extends BaseMethodBinding<ca.uhn.fhir.rest.api.MethodOutcome>

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.
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()
boolean	incomingServerRequestMatchesMethod(RequestDetails theRequest)
Object	invokeServer(IRestfulServer<?> theServer, RequestDetails theRequest)
boolean	isReturnVoid()
protected static void	parseContentLocation(ca.uhn.fhir.context.FhirContext theContext, ca.uhn.fhir.rest.api.MethodOutcome theOutcomeToPopulate, String theLocationHeader)
protected void	populateActionRequestDetailsForInterceptor(RequestDetails theRequestDetails, IServerInterceptor.ActionRequestDetails theDetails, Object[] theMethodParams) Subclasses may override this method (but should also call super.#populateActionRequestDetailsForInterceptor(RequestDetails, ActionRequestDetails, Object[]) 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, createAppropriateParserForParsingResponse, createAppropriateParserForParsingServerRequest, createMethodParams, createParametersForServerRequest, getAllowableParamAnnotations, getContext, getIncludes, getMethod, getParameters, getProvider, getRequestIncludesFromParams, getRestOperationType, invokeServerMethod, isGlobalMethod, isSupportsConditional, isSupportsConditionalMultiple, processNon2xxResponseAndReturnExceptionToThrow, setParameters, toResourceList, verifyMethodHasZeroOrOneOperationAnnotation

Methods inherited from class java.lang.Object

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

Constructor Detail

CreateMethodBinding

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

Method Detail

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

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

addParametersForServerRequest

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

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

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.#populateActionRequestDetailsForInterceptor(RequestDetails, ActionRequestDetails, Object[]) to provide method specifics to the interceptors.

Overrides:

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

Parameters:

theRequestDetails - The server request details

theDetails - The details object to populate

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

Specified by:

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

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()

parseContentLocation

protected static void parseContentLocation(ca.uhn.fhir.context.FhirContext theContext,
                                           ca.uhn.fhir.rest.api.MethodOutcome theOutcomeToPopulate,
                                           String theLocationHeader)