ca.uhn.fhir.rest.method

Class UpdateMethodBinding

java.lang.Object

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

ca.uhn.fhir.rest.method.UpdateMethodBinding

All Implemented Interfaces:

IClientResponseHandler<MethodOutcome>

public class UpdateMethodBinding
extends BaseMethodBinding<MethodOutcome>

Nested Class Summary

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

BaseMethodBinding.ActiveRequestReader, BaseMethodBinding.InactiveRequestReader, BaseMethodBinding.IRequestReader

Constructor Summary

Constructors

Constructor and Description
UpdateMethodBinding(Method theMethod, 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 BaseHttpClientInvocation	createClientInvocation(Object[] theArgs, IResource theResource)
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
RestOperationTypeEnum	getRestOperationType()
boolean	incomingServerRequestMatchesMethod(RequestDetails theRequest)
BaseHttpClientInvocation	invokeClient(Object[] theArgs)
MethodOutcome	invokeClient(String theResponseMimeType, Reader theResponseReader, int theResponseStatusCode, Map<String,List<String>> theHeaders)
Object	invokeServer(IRestfulServer<?> theServer, RequestDetails theRequest)
boolean	isReturnVoid()
protected static void	parseContentLocation(FhirContext theContext, MethodOutcome theOutcomeToPopulate, String theResourceName, 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<RequestTypeEnum>	provideAllowableRequestTypes()
protected void	streamOperationOutcome(BaseServerResponseException theE, RestfulServer theServer, EncodingEnum theEncodingNotNull, javax.servlet.http.HttpServletResponse theResponse, RequestDetails theRequest)

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

bindMethod, createAppropriateParserForParsingResponse, createAppropriateParserForParsingServerRequest, createParametersForServerRequest, getAllowableParamAnnotations, getContext, getIncludes, getMethod, getParameters, getProvider, getRequestIncludesFromParams, getRestOperationType, invokeServerMethod, 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

UpdateMethodBinding

public UpdateMethodBinding(Method theMethod,
                           FhirContext theContext,
                           Object theProvider)

Method Detail

getRestOperationType

public RestOperationTypeEnum getRestOperationType()

Specified by:

getRestOperationType in class BaseMethodBinding<MethodOutcome>

addParametersForServerRequest

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

createClientInvocation

protected BaseHttpClientInvocation createClientInvocation(Object[] theArgs,
                                                          IResource theResource)

provideAllowableRequestTypes

protected Set<RequestTypeEnum> provideAllowableRequestTypes()

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.

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<MethodOutcome>

Parameters:

theRequestDetails - The server request details

theDetails - The details object to populate

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

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<MethodOutcome>

invokeClient

public BaseHttpClientInvocation invokeClient(Object[] theArgs)
                                      throws InternalErrorException

Specified by:

invokeClient in class BaseMethodBinding<MethodOutcome>

Throws:

InternalErrorException

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<MethodOutcome>

invokeClient

public MethodOutcome invokeClient(String theResponseMimeType,
                                  Reader theResponseReader,
                                  int theResponseStatusCode,
                                  Map<String,List<String>> theHeaders)
                           throws BaseServerResponseException

Throws:

BaseServerResponseException

invokeServer

public Object invokeServer(IRestfulServer<?> theServer,
                           RequestDetails theRequest)
                    throws BaseServerResponseException,
                           IOException

Specified by:

invokeServer in class BaseMethodBinding<MethodOutcome>

Throws:

BaseServerResponseException

IOException

isReturnVoid

public boolean isReturnVoid()

streamOperationOutcome

protected void streamOperationOutcome(BaseServerResponseException theE,
                                      RestfulServer theServer,
                                      EncodingEnum theEncodingNotNull,
                                      javax.servlet.http.HttpServletResponse theResponse,
                                      RequestDetails theRequest)
                               throws IOException

Throws:

IOException

parseContentLocation

protected static void parseContentLocation(FhirContext theContext,
                                           MethodOutcome theOutcomeToPopulate,
                                           String theResourceName,
                                           String theLocationHeader)