ca.uhn.fhir.rest.method

Class BaseOutcomeReturningMethodBindingWithResourceIdButNoResourceBody

java.lang.Object

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

ca.uhn.fhir.rest.method.BaseOutcomeReturningMethodBindingWithResourceIdButNoResourceBody

All Implemented Interfaces:

IClientResponseHandler<MethodOutcome>

Direct Known Subclasses:

DeleteMethodBinding, PatchMethodBinding

public abstract class BaseOutcomeReturningMethodBindingWithResourceIdButNoResourceBody
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
BaseOutcomeReturningMethodBindingWithResourceIdButNoResourceBody(Method theMethod, FhirContext theContext, Object theProvider, Class<?> theMethodAnnotationType, Class<? extends IBaseResource> theResourceTypeFromAnnotation)

Method Summary

Modifier and Type	Method and Description
protected abstract 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 abstract BaseHttpClientInvocation	createClientInvocation(Object[] theArgs, IResource 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
boolean	incomingServerRequestMatchesMethod(RequestDetails theRequest)
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 theLocationHeader)
protected abstract 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, getRestOperationType, invokeClient, invokeServerMethod, isSupportsConditional, isSupportsConditionalMultiple, populateActionRequestDetailsForInterceptor, processNon2xxResponseAndReturnExceptionToThrow, setParameters, toResourceList, 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,
                                                                        FhirContext theContext,
                                                                        Object theProvider,
                                                                        Class<?> theMethodAnnotationType,
                                                                        Class<? extends 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<MethodOutcome>

getIdParameterIndex

protected Integer getIdParameterIndex()

addParametersForServerRequest

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

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,
                                                                   IResource 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.

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

provideAllowableRequestTypes

protected abstract Set<RequestTypeEnum> provideAllowableRequestTypes()

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