ca.uhn.fhir.rest.method

Class SearchMethodBinding

java.lang.Object

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

ca.uhn.fhir.rest.method.BaseResourceReturningMethodBinding

ca.uhn.fhir.rest.method.SearchMethodBinding

All Implemented Interfaces:

IClientResponseHandler<Object>

public class SearchMethodBinding
extends BaseResourceReturningMethodBinding

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SearchMethodBinding.QualifierDetails

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

BaseResourceReturningMethodBinding.MethodReturnTypeEnum, BaseResourceReturningMethodBinding.ResourceOrDstu1Bundle, BaseResourceReturningMethodBinding.ReturnTypeEnum

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

BaseMethodBinding.ActiveRequestReader, BaseMethodBinding.InactiveRequestReader, BaseMethodBinding.IRequestReader

Field Summary

Fields inherited from class ca.uhn.fhir.rest.method.BaseResourceReturningMethodBinding

ALLOWED_PARAMS

Constructor Summary

Constructors

Constructor and Description
SearchMethodBinding(Class<? extends IBaseResource> theReturnResourceType, Method theMethod, FhirContext theContext, Object theProvider)

Method Summary

Modifier and Type	Method and Description
static BaseHttpClientInvocation	createSearchInvocation(FhirContext theContext, String theResourceName, Map<String,List<String>> theParameters, IdDt theId, String theCompartmentName, SearchStyleEnum theSearchStyle)
static BaseHttpClientInvocation	createSearchInvocation(String theSearchUrl, Map<String,List<String>> theParams)
static SearchMethodBinding.QualifierDetails	extractQualifiersFromParameterName(String theParamName)
String	getDescription()
protected BundleTypeEnum	getResponseBundleType() If the response is a bundle, this type will be placed in the root of the bundle (can be null)
RestOperationTypeEnum	getRestOperationType()
BaseResourceReturningMethodBinding.ReturnTypeEnum	getReturnType()
boolean	incomingServerRequestMatchesMethod(RequestDetails theRequest)
BaseHttpClientInvocation	invokeClient(Object[] theArgs)
IBundleProvider	invokeServer(IRestfulServer theServer, RequestDetails theRequest, Object[] theMethodParams)
protected boolean	isAddContentLocationHeader() Should the response include a Content-Location header.
String	toString()

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

getMethodReturnType, getResourceName, invokeClient, invokeServer, invokeServer, setResourceName

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, populateActionRequestDetailsForInterceptor, processNon2xxResponseAndReturnExceptionToThrow, setParameters, toResourceList, verifyMethodHasZeroOrOneOperationAnnotation

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchMethodBinding

public SearchMethodBinding(Class<? extends IBaseResource> theReturnResourceType,
                           Method theMethod,
                           FhirContext theContext,
                           Object theProvider)

Method Detail

getDescription

public String getDescription()

getRestOperationType

public RestOperationTypeEnum getRestOperationType()

Specified by:

getRestOperationType in class BaseMethodBinding<Object>

getResponseBundleType

protected BundleTypeEnum getResponseBundleType()

Description copied from class: BaseResourceReturningMethodBinding

If the response is a bundle, this type will be placed in the root of the bundle (can be null)

Specified by:

getResponseBundleType in class BaseResourceReturningMethodBinding

getReturnType

public BaseResourceReturningMethodBinding.ReturnTypeEnum getReturnType()

Specified by:

getReturnType in class BaseResourceReturningMethodBinding

incomingServerRequestMatchesMethod

public boolean incomingServerRequestMatchesMethod(RequestDetails theRequest)

Specified by:

incomingServerRequestMatchesMethod in class BaseMethodBinding<Object>

invokeClient

public BaseHttpClientInvocation invokeClient(Object[] theArgs)
                                      throws InternalErrorException

Specified by:

invokeClient in class BaseMethodBinding<Object>

Throws:

InternalErrorException

invokeServer

public IBundleProvider invokeServer(IRestfulServer theServer,
                                    RequestDetails theRequest,
                                    Object[] theMethodParams)
                             throws InvalidRequestException,
                                    InternalErrorException

Specified by:

invokeServer in class BaseResourceReturningMethodBinding

Throws:

InvalidRequestException

InternalErrorException

isAddContentLocationHeader

protected boolean isAddContentLocationHeader()

Description copied from class: BaseResourceReturningMethodBinding

Should the response include a Content-Location header. Search method bunding (and any others?) may override this to disable the content-location, since it doesn't make sense

Overrides:

isAddContentLocationHeader in class BaseResourceReturningMethodBinding

toString

public String toString()

Overrides:

toString in class Object

createSearchInvocation

public static BaseHttpClientInvocation createSearchInvocation(FhirContext theContext,
                                                              String theResourceName,
                                                              Map<String,List<String>> theParameters,
                                                              IdDt theId,
                                                              String theCompartmentName,
                                                              SearchStyleEnum theSearchStyle)

extractQualifiersFromParameterName

public static SearchMethodBinding.QualifierDetails extractQualifiersFromParameterName(String theParamName)

createSearchInvocation

public static BaseHttpClientInvocation createSearchInvocation(String theSearchUrl,
                                                              Map<String,List<String>> theParams)