ca.uhn.fhir.rest.client.method

Class BaseOutcomeReturningMethodBindingWithResourceIdButNoResourceBody

java.lang.Object

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

ca.uhn.fhir.rest.client.method.BaseOutcomeReturningMethodBindingWithResourceIdButNoResourceBody

All Implemented Interfaces:

IClientResponseHandler<ca.uhn.fhir.rest.api.MethodOutcome>

Direct Known Subclasses:

DeleteMethodBinding, PatchMethodBinding

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

Constructor Summary

Constructors

Constructor and Description
BaseOutcomeReturningMethodBindingWithResourceIdButNoResourceBody(Method theMethod, ca.uhn.fhir.context.FhirContext theContext, Object theProvider, Class<?> theMethodAnnotationType, Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theResourceTypeFromAnnotation)

Method Summary

Modifier and Type	Method and Description
protected boolean	allowVoidReturnType() Subclasses may override to allow a void method return type, which is allowable for some methods (e.g.
protected abstract BaseHttpClientInvocation	createClientInvocation(Object[] theArgs, org.hl7.fhir.instance.model.api.IBaseResource resource)
protected Integer	getIdParameterIndex()
protected abstract 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.MethodOutcome	invokeClient(String theResponseMimeType, InputStream theResponseInputStream, int theResponseStatusCode, Map<String,List<String>> theHeaders)
boolean	isReturnVoid()
protected static void	parseContentLocation(ca.uhn.fhir.context.FhirContext theContext, ca.uhn.fhir.rest.api.MethodOutcome theOutcomeToPopulate, String theLocationHeader)
protected abstract Set<ca.uhn.fhir.rest.api.RequestTypeEnum>	provideAllowableRequestTypes()

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

bindMethod, createAppropriateParserForParsingResponse, getAllowableParamAnnotations, getContext, getIncludes, getMethod, getParameters, getProvider, getRestOperationType, invokeClient, isResourceInterface, isSupportsConditional, isSupportsConditionalMultiple, processNon2xxResponseAndReturnExceptionToThrow, setParameters, verifyMethodHasZeroOrOneOperationAnnotation

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseOutcomeReturningMethodBindingWithResourceIdButNoResourceBody

public BaseOutcomeReturningMethodBindingWithResourceIdButNoResourceBody(Method theMethod,
                                                                        ca.uhn.fhir.context.FhirContext theContext,
                                                                        Object theProvider,
                                                                        Class<?> theMethodAnnotationType,
                                                                        Class<? extends org.hl7.fhir.instance.model.api.IBaseResource> theResourceTypeFromAnnotation)

Method Detail

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>

getIdParameterIndex

protected Integer getIdParameterIndex()

allowVoidReturnType

protected boolean allowVoidReturnType()

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

createClientInvocation

protected abstract BaseHttpClientInvocation createClientInvocation(Object[] theArgs,
                                                                   org.hl7.fhir.instance.model.api.IBaseResource resource)

getMatchingOperation

protected abstract 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.

invokeClient

public ca.uhn.fhir.rest.api.MethodOutcome invokeClient(String theResponseMimeType,
                                                       InputStream theResponseInputStream,
                                                       int theResponseStatusCode,
                                                       Map<String,List<String>> theHeaders)
                                                throws ca.uhn.fhir.rest.server.exceptions.BaseServerResponseException

Throws:

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

isReturnVoid

public boolean isReturnVoid()

provideAllowableRequestTypes

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

parseContentLocation

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