Index

A B C D E F G H I L M N O P R S T U V W
All Classes All Packages

A

ActionRequestDetails(RequestDetails) - Constructor for class ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails

Deprecated.

ActionRequestDetails(RequestDetails, FhirContext, String, IIdType) - Constructor for class ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails

Deprecated.

ActionRequestDetails(RequestDetails, FhirContext, IBaseResource) - Constructor for class ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails

Deprecated.

ActionRequestDetails(RequestDetails, String, IIdType) - Constructor for class ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails

Deprecated.

ActionRequestDetails(RequestDetails, IBaseResource) - Constructor for class ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails

Deprecated.

ActionRequestDetails(RequestDetails, IBaseResource, String, IIdType) - Constructor for class ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails

Deprecated.

ActionRequestDetails(RequestDetails, IIdType) - Constructor for class ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails

Deprecated.

Constructor

addCompartment(String) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizedList

Adds a compartment that the user should be allowed to access

addCompartments(String...) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizedList

Adds a compartment that the user should be allowed to access

addExcludeOperationType(RestOperationTypeEnum) - Method in class ca.uhn.fhir.rest.server.interceptor.ResponseValidatingInterceptor

Do not validate the following operations.

addHeader(String, String) - Method in interface ca.uhn.fhir.rest.api.server.IRestfulResponse

addHeader(String, String) - Method in class ca.uhn.fhir.rest.server.RestfulResponse

addHeader(String, String) - Method in class ca.uhn.fhir.rest.server.servlet.ServletSubRequestDetails

addHeadersToResponse(HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.RestfulServer

This method is called prior to sending a response to incoming requests.

addMethod(BaseMethodBinding<?>) - Method in class ca.uhn.fhir.rest.server.ResourceBinding

addParameter(String, String[]) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

addParametersForServerRequest(RequestDetails, Object[]) - Method in class ca.uhn.fhir.rest.server.method.DeleteMethodBinding

addParametersForServerRequest(RequestDetails, Object[]) - Method in class ca.uhn.fhir.rest.server.method.PatchMethodBinding

addParametersForServerRequest(RequestDetails, Object[]) - Method in class ca.uhn.fhir.rest.server.method.UpdateMethodBinding

addRequestIdToResponse(ServletRequestDetails, String) - Method in class ca.uhn.fhir.rest.server.RestfulServer

addResolvedResourceId(IIdType, ResourcePersistentId) - Method in class ca.uhn.fhir.rest.api.server.storage.TransactionDetails

A Resolved Resource ID is a mapping between a resource ID (e.g.

addResource(String) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizedList

Adds a resource that the user should be allowed to access

addResources(String...) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizedList

Adds a resource that the user should be allowed to access

addSupplier(Supplier<Object>) - Method in class ca.uhn.fhir.rest.server.provider.ResourceProviderFactory

addValidatorModule(IValidatorModule) - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

allow() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilder

Start a new rule to allow a given operation

allow() - Method in class ca.uhn.fhir.rest.server.interceptor.auth.RuleBuilder

allow(String) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilder

Start a new rule to allow a given operation

allow(String) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.RuleBuilder

ALLOW - ca.uhn.fhir.rest.server.interceptor.auth.PolicyEnum

ALLOW_PATCH_REQUEST_UNCHALLENGED - ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationFlagsEnum

allowAll() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilder

This rule allows any invocation to proceed.

allowAll() - Method in class ca.uhn.fhir.rest.server.interceptor.auth.RuleBuilder

allowAll(String) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilder

This rule allows any invocation to proceed.

allowAll(String) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.RuleBuilder

allowVoidReturnType() - Method in class ca.uhn.fhir.rest.server.method.DeleteMethodBinding

allowVoidReturnType() - Method in class ca.uhn.fhir.rest.server.method.PatchMethodBinding

allRequests() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderPatch

With this setting, all patch requests will be permitted to proceed.

allResources() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderAppliesTo

Rule applies to all resources

andAllowAllResponses() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderOperationNamedAndScoped

Responses for this operation will not be checked

andApplyNormalRules() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRuleTransactionOp

andRequireExplicitResponseAuthorization() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderOperationNamedAndScoped

Responses for this operation must be authorized by other rules.

andThen() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleFinished

Start another rule

any() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderGraphQL

Allow any GraphQL request.

ApacheProxyAddressStrategy - Class in ca.uhn.fhir.rest.server

Works like the normal IncomingRequestAddressStrategy unless there's an x-forwarded-host present, in which case that's used in place of the server's address.

ApacheProxyAddressStrategy(boolean) - Constructor for class ca.uhn.fhir.rest.server.ApacheProxyAddressStrategy

applyETagAsVersion(RequestDetails, IIdType) - Static method in class ca.uhn.fhir.rest.server.method.UpdateMethodBinding

applyFilterToList() - Method in class ca.uhn.fhir.rest.api.server.SimplePreResourceAccessDetails

Remove any blocked resources from the list that was passed into the constructor

applyRule(RestOperationTypeEnum, RequestDetails, IBaseResource, IIdType, IBaseResource, IRuleApplier, Set<AuthorizationFlagsEnum>, Pointcut) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRule

Applies the rule and returns a policy decision, or null if the rule does not apply

applyRule(RestOperationTypeEnum, RequestDetails, IBaseResource, IIdType, IBaseResource, IRuleApplier, Set<AuthorizationFlagsEnum>, Pointcut) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.RuleImplConditional

applyRulesAndReturnDecision(RestOperationTypeEnum, RequestDetails, IBaseResource, IIdType, IBaseResource, Pointcut) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

applyRulesAndReturnDecision(RestOperationTypeEnum, RequestDetails, IBaseResource, IIdType, IBaseResource, Pointcut) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IRuleApplier

APPROXIMATE - ca.uhn.fhir.rest.server.method.MethodMatchEnum

atAnyLevel() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderOperationNamed

Rule applies to invocations of this operation at any level (server, type or instance)

attach(IResourceProviderFactoryObserver) - Method in class ca.uhn.fhir.rest.server.provider.ResourceProviderFactory

AuthorizationFlagsEnum - Enum in ca.uhn.fhir.rest.server.interceptor.auth

AuthorizationInterceptor - Class in ca.uhn.fhir.rest.server.interceptor.auth

This class is a base class for interceptors which can be used to inspect requests and responses to determine whether the calling user has permission to perform the given action.

AuthorizationInterceptor() - Constructor for class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

Constructor

AuthorizationInterceptor(PolicyEnum) - Constructor for class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

Constructor

AuthorizationInterceptor.Verdict - Class in ca.uhn.fhir.rest.server.interceptor.auth

AUTHORIZED - ca.uhn.fhir.rest.server.interceptor.consent.ConsentOperationStatusEnum

The engine has nothing to say about the operation (same as proceed, but the host application need not consult the engine - can use more efficient counting/caching methods)

AUTHORIZED - Static variable in class ca.uhn.fhir.rest.server.interceptor.consent.ConsentOutcome

Convenience constant containing new ConsentOutcome(ConsentOperationStatusEnum.AUTHORIZED)

AuthorizedList - Class in ca.uhn.fhir.rest.server.interceptor.auth

Return type for SearchNarrowingInterceptor.buildAuthorizedList(RequestDetails)

AuthorizedList() - Constructor for class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizedList

B

BanUnsupportedHttpMethodsInterceptor - Class in ca.uhn.fhir.rest.server.interceptor

This interceptor causes the server to reject invocations for HTTP methods other than those supported by the server with an HTTP 405.

BanUnsupportedHttpMethodsInterceptor() - Constructor for class ca.uhn.fhir.rest.server.interceptor.BanUnsupportedHttpMethodsInterceptor

BaseLastNProvider - Class in ca.uhn.fhir.rest.server.provider

This class implements the Observation $lastn operation.

BaseLastNProvider() - Constructor for class ca.uhn.fhir.rest.server.provider.BaseLastNProvider

BaseMethodBinding<T> - Class in ca.uhn.fhir.rest.server.method

BaseMethodBinding(Method, FhirContext, Object) - Constructor for class ca.uhn.fhir.rest.server.method.BaseMethodBinding

BaseOutcomeReturningMethodBindingWithResourceIdButNoResourceBody - Class in ca.uhn.fhir.rest.server.method

BaseOutcomeReturningMethodBindingWithResourceIdButNoResourceBody(Method, FhirContext, Object, Class<?>, Class<? extends IBaseResource>) - Constructor for class ca.uhn.fhir.rest.server.method.BaseOutcomeReturningMethodBindingWithResourceIdButNoResourceBody

BasePagingProvider - Class in ca.uhn.fhir.rest.server

BasePagingProvider() - Constructor for class ca.uhn.fhir.rest.server.BasePagingProvider

BaseQueryParameter - Class in ca.uhn.fhir.rest.server.method

BaseQueryParameter() - Constructor for class ca.uhn.fhir.rest.server.method.BaseQueryParameter

BaseResourceReturningMethodBinding - Class in ca.uhn.fhir.rest.server.method

BaseResourceReturningMethodBinding(Class<?>, Method, FhirContext, Object) - Constructor for class ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding

BaseResourceReturningMethodBinding.MethodReturnTypeEnum - Enum in ca.uhn.fhir.rest.server.method

BaseResourceReturningMethodBinding.ReturnTypeEnum - Enum in ca.uhn.fhir.rest.server.method

BaseServerCapabilityStatementProvider - Class in ca.uhn.fhir.rest.server.util

BaseServerCapabilityStatementProvider() - Constructor for class ca.uhn.fhir.rest.server.util.BaseServerCapabilityStatementProvider

BaseServerCapabilityStatementProvider(RestfulServerConfiguration) - Constructor for class ca.uhn.fhir.rest.server.util.BaseServerCapabilityStatementProvider

BaseValidatingInterceptor<T> - Class in ca.uhn.fhir.rest.server.interceptor

This interceptor intercepts each incoming request and if it contains a FHIR resource, validates that resource.

BaseValidatingInterceptor() - Constructor for class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

Bindings - Class in ca.uhn.fhir.rest.server

Bindings(IdentityHashMap<SearchMethodBinding, String>, HashMap<String, List<SearchMethodBinding>>, HashMap<String, List<OperationMethodBinding>>, IdentityHashMap<OperationMethodBinding, String>) - Constructor for class ca.uhn.fhir.rest.server.Bindings

bindMethod(Method, FhirContext, Object) - Static method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

BODY - ca.uhn.fhir.rest.server.method.ResourceParameter.Mode

BODY_BYTE_ARRAY - ca.uhn.fhir.rest.server.method.ResourceParameter.Mode

build() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilder

Build the rule list

build() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleFinished

Build the rule list

build() - Method in class ca.uhn.fhir.rest.server.interceptor.auth.RuleBuilder

buildAuthorizedList(RequestDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.SearchNarrowingInterceptor

Subclasses should override this method to supply the set of compartments that the user making the request should actually have access to.

buildRuleList(RequestDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

Subclasses should override this method to supply the set of rules to be applied to this individual request.

BUNDLE - ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding.MethodReturnTypeEnum

BUNDLE - ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding.ReturnTypeEnum

BUNDLE_PROVIDER - ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding.MethodReturnTypeEnum

BUNDLE_RESOURCE - ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding.MethodReturnTypeEnum

BundleProviders - Class in ca.uhn.fhir.rest.server

Utility methods for working with IBundleProvider

BundleProviderWithNamedPages - Class in ca.uhn.fhir.rest.server

Bundle provider that uses named pages instead of counts

BundleProviderWithNamedPages(List<IBaseResource>, String, String, Integer) - Constructor for class ca.uhn.fhir.rest.server.BundleProviderWithNamedPages

Constructor

C

ca.uhn.fhir.rest.api.server - package ca.uhn.fhir.rest.api.server

ca.uhn.fhir.rest.api.server.storage - package ca.uhn.fhir.rest.api.server.storage

ca.uhn.fhir.rest.server - package ca.uhn.fhir.rest.server

ca.uhn.fhir.rest.server.interceptor - package ca.uhn.fhir.rest.server.interceptor

ca.uhn.fhir.rest.server.interceptor.auth - package ca.uhn.fhir.rest.server.interceptor.auth

ca.uhn.fhir.rest.server.interceptor.consent - package ca.uhn.fhir.rest.server.interceptor.consent

ca.uhn.fhir.rest.server.interceptor.partition - package ca.uhn.fhir.rest.server.interceptor.partition

ca.uhn.fhir.rest.server.method - package ca.uhn.fhir.rest.server.method

ca.uhn.fhir.rest.server.provider - package ca.uhn.fhir.rest.server.provider

ca.uhn.fhir.rest.server.servlet - package ca.uhn.fhir.rest.server.servlet

ca.uhn.fhir.rest.server.tenant - package ca.uhn.fhir.rest.server.tenant

ca.uhn.fhir.rest.server.util - package ca.uhn.fhir.rest.server.util

callOutgoingFailureOperationOutcomeHook(RequestDetails, IBaseOperationOutcome) - Static method in class ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding

callOutgoingResponseHook(RequestDetails, ResponseDetails) - Static method in class ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding

canSeeResource(RequestDetails, IBaseResource, IConsentContextServices) - Method in class ca.uhn.fhir.rest.server.interceptor.consent.DelegatingConsentService

canSeeResource(RequestDetails, IBaseResource, IConsentContextServices) - Method in interface ca.uhn.fhir.rest.server.interceptor.consent.IConsentService

This method is called if a user may potentially see a resource via READ operations, SEARCH operations, etc.

capture(RequestDetails, Writer) - Method in class ca.uhn.fhir.rest.server.interceptor.ResponseSizeCapturingInterceptor

CaptureResourceSourceFromHeaderInterceptor - Class in ca.uhn.fhir.rest.server.interceptor

This interceptor examines a header on the incoming request and places it in Resource.meta.source (R4 and above) or in an extension on Resource.meta with the URL http://hapifhir.io/fhir/StructureDefinition/resource-meta-source (DSTU3).

CaptureResourceSourceFromHeaderInterceptor(FhirContext) - Constructor for class ca.uhn.fhir.rest.server.interceptor.CaptureResourceSourceFromHeaderInterceptor

clear() - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

Clear all data held in this resource provider

clearCounts() - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

Clear the counts used by HashMapResourceProvider.getCountRead() and other count methods

collectMethodBindings() - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

CommonResourceSupertypeScanner - Class in ca.uhn.fhir.rest.server

When populating the StructureDefinition links in a capability statement, it can be useful to know the lowest common superclass for the profiles in use for a given resource name.

CommonResourceSupertypeScanner() - Constructor for class ca.uhn.fhir.rest.server.CommonResourceSupertypeScanner

completed(RequestDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.ResponseSizeCapturingInterceptor

completeOperationFailure(RequestDetails, BaseServerResponseException, IConsentContextServices) - Method in class ca.uhn.fhir.rest.server.interceptor.consent.DelegatingConsentService

completeOperationFailure(RequestDetails, BaseServerResponseException, IConsentContextServices) - Method in interface ca.uhn.fhir.rest.server.interceptor.consent.IConsentService

This method is called when an operation is complete.

completeOperationSuccess(RequestDetails, IConsentContextServices) - Method in class ca.uhn.fhir.rest.server.interceptor.consent.DelegatingConsentService

completeOperationSuccess(RequestDetails, IConsentContextServices) - Method in interface ca.uhn.fhir.rest.server.interceptor.consent.IConsentService

This method is called when an operation is complete.

computeSharedSupertypeForResourcePerName(Collection<IResourceProvider>) - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

configureResponseParser(RequestDetails, IParser) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

ConformanceMethodBinding - Class in ca.uhn.fhir.rest.server.method

ConsentInterceptor - Class in ca.uhn.fhir.rest.server.interceptor.consent

ConsentInterceptor() - Constructor for class ca.uhn.fhir.rest.server.interceptor.consent.ConsentInterceptor

Constructor

ConsentInterceptor(IConsentService) - Constructor for class ca.uhn.fhir.rest.server.interceptor.consent.ConsentInterceptor

Constructor

ConsentInterceptor(IConsentService, IConsentContextServices) - Constructor for class ca.uhn.fhir.rest.server.interceptor.consent.ConsentInterceptor

Constructor

ConsentOperationStatusEnum - Enum in ca.uhn.fhir.rest.server.interceptor.consent

ConsentOutcome - Class in ca.uhn.fhir.rest.server.interceptor.consent

ConsentOutcome(ConsentOperationStatusEnum) - Constructor for class ca.uhn.fhir.rest.server.interceptor.consent.ConsentOutcome

ConsentOutcome(ConsentOperationStatusEnum, IBaseOperationOutcome) - Constructor for class ca.uhn.fhir.rest.server.interceptor.consent.ConsentOutcome

ConsentOutcome(ConsentOperationStatusEnum, IBaseResource) - Constructor for class ca.uhn.fhir.rest.server.interceptor.consent.ConsentOutcome

CorsInterceptor - Class in ca.uhn.fhir.rest.server.interceptor

CorsInterceptor() - Constructor for class ca.uhn.fhir.rest.server.interceptor.CorsInterceptor

Constructor which creates an interceptor with default CORS configuration for use in a FHIR server.

CorsInterceptor(CorsConfiguration) - Constructor for class ca.uhn.fhir.rest.server.interceptor.CorsInterceptor

Constructor which accepts the given configuration

CountParameter - Class in ca.uhn.fhir.rest.server.method

CountParameter() - Constructor for class ca.uhn.fhir.rest.server.method.CountParameter

create() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRule

This rule specifically allows a user to perform a FHIR create, but not an update or other write operations

create(T, RequestDetails) - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

createConditional() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRule

This rule applies to create operations with a conditional URL as a part of the request.

createConfiguration() - Method in class ca.uhn.fhir.rest.server.RestfulServer

createEtag(String) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

CreateMethodBinding - Class in ca.uhn.fhir.rest.server.method

CreateMethodBinding(Method, FhirContext, Object) - Constructor for class ca.uhn.fhir.rest.server.method.CreateMethodBinding

createMethodParams(RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

createPagingLink(Set<Include>, RequestDetails, String, int, int, Map<String, String[]>, boolean, BundleTypeEnum) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

createPagingLink(Set<Include>, RequestDetails, String, String, Map<String, String[]>, boolean, BundleTypeEnum) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

createParametersForServerRequest(RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

createPoweredByAttributes() - Method in class ca.uhn.fhir.rest.server.RestfulServer

createPoweredByHeader() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Subclasses may override to provide their own powered by header.

createPoweredByHeaderComponentName() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Subclasses my override

createPoweredByHeaderProductName() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Subclasses my override

createPoweredByHeaderProductVersion() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Subclasses my override

createProviders() - Method in class ca.uhn.fhir.rest.server.provider.ResourceProviderFactory

createRequestReader(RequestDetails) - Static method in class ca.uhn.fhir.rest.server.method.ResourceParameter

createServerConformanceProvider(RestfulServer) - Method in interface ca.uhn.fhir.rest.api.server.IFhirVersionServer

createSortStringDstu3(SortSpec) - Static method in class ca.uhn.fhir.rest.server.method.SortParameter

D

DEFAULT_DEFAULT_PAGE_SIZE - Static variable in class ca.uhn.fhir.rest.server.BasePagingProvider

DEFAULT_ETAG_SUPPORT - Static variable in class ca.uhn.fhir.rest.server.RestfulServer

Default setting for ETag Support: ETagSupportEnum.ENABLED

DEFAULT_MAX_PAGE_SIZE - Static variable in class ca.uhn.fhir.rest.server.BasePagingProvider

DEFAULT_PREFER_RETURN - Static variable in class ca.uhn.fhir.rest.server.RestfulServer

Default value for RestfulServer.setDefaultPreferReturn(PreferReturnEnum)

DEFAULT_RESPONSE_HEADER_NAME - Static variable in class ca.uhn.fhir.rest.server.interceptor.RequestValidatingInterceptor

X-HAPI-Request-Validation

DEFAULT_RESPONSE_HEADER_NAME - Static variable in class ca.uhn.fhir.rest.server.interceptor.ResponseValidatingInterceptor

X-HAPI-Request-Validation

DEFAULT_RESPONSE_HEADER_VALUE - Static variable in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

Default value:
${row}:${col} ${severity} ${message} (${location})

DelegatingConsentService - Class in ca.uhn.fhir.rest.server.interceptor.consent

Implementation of IConsentService that forwards to another implementation of IConsentService.

DelegatingConsentService() - Constructor for class ca.uhn.fhir.rest.server.interceptor.consent.DelegatingConsentService

delete() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRule

This rule applies to the FHIR delete operation

delete(IIdType, RequestDetails) - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

deleteConditional() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRule

This rule applies to create operations with a conditional URL as a part of the request.

DeleteMethodBinding - Class in ca.uhn.fhir.rest.server.method

DeleteMethodBinding(Method, FhirContext, Object) - Constructor for class ca.uhn.fhir.rest.server.method.DeleteMethodBinding

deny() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilder

Start a new rule to deny a given operation

deny() - Method in class ca.uhn.fhir.rest.server.interceptor.auth.RuleBuilder

deny(String) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilder

Start a new rule to deny a given operation

deny(String) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.RuleBuilder

DENY - ca.uhn.fhir.rest.server.interceptor.auth.PolicyEnum

denyAll() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilder

This rule allows any invocation to proceed.

denyAll() - Method in class ca.uhn.fhir.rest.server.interceptor.auth.RuleBuilder

denyAll(String) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilder

This rule allows any invocation to proceed.

denyAll(String) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.RuleBuilder

destroy() - Method in class ca.uhn.fhir.rest.server.RestfulServer

detach(IResourceProviderFactoryObserver) - Method in class ca.uhn.fhir.rest.server.provider.ResourceProviderFactory

determineRequestCharset(RequestDetails) - Static method in class ca.uhn.fhir.rest.server.method.ResourceParameter

determineRequestEncodingNoDefault(RequestDetails) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

determineRequestEncodingNoDefault(RequestDetails, boolean) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

determineResourceMethod(RequestDetails, String) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Figure out and return whichever method binding is appropriate for the given request

determineResponseEncodingNoDefault(RequestDetails, EncodingEnum) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

Returns null if the request doesn't express that it wants FHIR.

determineResponseEncodingNoDefault(RequestDetails, EncodingEnum, String) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

Try to determing the response content type, given the request Accept header and _format parameter.

determineResponseEncodingWithDefault(RequestDetails) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

Determine whether a response should be given in JSON or XML format based on the incoming HttpServletRequest's "_format" parameter and "Accept:" HTTP header.

determineServerBase(ServletContext, HttpServletRequest) - Method in class ca.uhn.fhir.rest.server.ApacheProxyAddressStrategy

determineServerBase(ServletContext, HttpServletRequest) - Method in class ca.uhn.fhir.rest.server.HardcodedServerAddressStrategy

determineServerBase(ServletContext, HttpServletRequest) - Method in class ca.uhn.fhir.rest.server.IncomingRequestAddressStrategy

determineServerBase(ServletContext, HttpServletRequest) - Method in interface ca.uhn.fhir.rest.server.IServerAddressStrategy

Determine the server base for a given request

determineServletContextPath(HttpServletRequest, RestfulServer) - Static method in class ca.uhn.fhir.rest.server.IncomingRequestAddressStrategy

Determines the servlet's context path.

determineSummaryMode(RequestDetails) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

DIFF_FROM_PARAMETER - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

DIFF_FROM_VERSION_PARAMETER - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

DIFF_INCLUDE_META_PARAMETER - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

DIFF_OPERATION_NAME - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

Operation name: diff

DIFF_TO_PARAMETER - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

DISABLED - ca.uhn.fhir.rest.server.ETagSupportEnum

Do not send ETag headers

doDelete(HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.RestfulServer

doGet(HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.RestfulServer

doInvokeServer(IRestfulServer<?>, RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding

doInvokeServer(IRestfulServer<?>, RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.PageMethodBinding

doOptions(HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.RestfulServer

doPost(HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.RestfulServer

doPut(HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.RestfulServer

E

ElementsParameter - Class in ca.uhn.fhir.rest.server.method

ElementsParameter() - Constructor for class ca.uhn.fhir.rest.server.method.ElementsParameter

ElementsSupportEnum - Enum in ca.uhn.fhir.rest.server

EMPI_DUPLICATE_PERSONS - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

EMPI_MATCH - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

EMPI Operations

EMPI_MATCH_RESOURCE - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

EMPI_MERGE_PERSONS - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

EMPI_MERGE_PERSONS_PERSON_ID_TO_DELETE - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

EMPI_MERGE_PERSONS_PERSON_ID_TO_KEEP - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

EMPI_QUERY_LINKS - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

EMPI_QUERY_LINKS_LINK_SOURCE - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

EMPI_QUERY_LINKS_MATCH_RESULT - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

EMPI_QUERY_LINKS_PERSON_ID - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

EMPI_QUERY_LINKS_TARGET_ID - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

EMPI_UPDATE_LINK - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

EMPI_UPDATE_LINK_MATCH_RESULT - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

EMPI_UPDATE_LINK_PERSON_ID - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

EMPI_UPDATE_LINK_TARGET_ID - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

ENABLED - ca.uhn.fhir.rest.server.ETagSupportEnum

Send ETag headers

encode(FhirContext, Object) - Method in class ca.uhn.fhir.rest.server.method.BaseQueryParameter

encode(FhirContext, Object) - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

ENCODING - ca.uhn.fhir.rest.server.method.ResourceParameter.Mode

equals(Object) - Method in class ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId

equals(Object) - Method in class ca.uhn.fhir.rest.server.ResourceBinding

escapedLength(String) - Static method in class ca.uhn.fhir.rest.server.RestfulServer

Count length of URL string, but treating unescaped sequences (e.g.

ETagSupportEnum - Enum in ca.uhn.fhir.rest.server

RESTful server behaviour for automatically adding profile tags

EXACT - ca.uhn.fhir.rest.server.method.MethodMatchEnum

ExceptionHandlingInterceptor - Class in ca.uhn.fhir.rest.server.interceptor

ExceptionHandlingInterceptor() - Constructor for class ca.uhn.fhir.rest.server.interceptor.ExceptionHandlingInterceptor

execute(IParser, Writer) - Method in class ca.uhn.fhir.rest.api.server.ParseAction

EXTENDED - ca.uhn.fhir.rest.server.ElementsSupportEnum

The server will support both the standard features as well as support for elements exclusion.

extractCountParameter(RequestDetails) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

extractDeleteCascadeParameter(RequestDetails) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

extractDescription(SearchParameter, Annotation[]) - Static method in class ca.uhn.fhir.rest.server.method.MethodUtil

extractLastUpdatedFromResource(IBaseResource) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

extractPartitionIdFromRequest(ServletRequestDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.partition.RequestTenantPartitionInterceptor

extractSource(RequestDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.CaptureResourceSourceFromHeaderInterceptor

extractTenant(UrlPathTokenizer, RequestDetails) - Method in interface ca.uhn.fhir.rest.server.tenant.ITenantIdentificationStrategy

Implementations should use this method to determine the tenant ID based on the incoming request andand populate it in the RequestDetails.setTenantId(String).

extractTenant(UrlPathTokenizer, RequestDetails) - Method in class ca.uhn.fhir.rest.server.tenant.UrlBaseTenantIdentificationStrategy

extractUrl(ServletRequestDetails) - Static method in class ca.uhn.fhir.rest.server.util.ServletRequestUtil

F

fail(RequestDetails, ValidationResult) - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

Fail the request by throwing an UnprocessableEntityException as a result of a validation failure.

FhirPathFilterInterceptor - Class in ca.uhn.fhir.rest.server.interceptor

This interceptor looks for a URL parameter on requests called _fhirpath and replaces the resource being returned with a Parameters resource containing the results of the given FHIRPath expression evaluated against the resource that would otherwise have been returned.

FhirPathFilterInterceptor() - Constructor for class ca.uhn.fhir.rest.server.interceptor.FhirPathFilterInterceptor

FifoMemoryPagingProvider - Class in ca.uhn.fhir.rest.server

FifoMemoryPagingProvider(int) - Constructor for class ca.uhn.fhir.rest.server.FifoMemoryPagingProvider

fireInterceptorsAndFilterAsNeeded(List<T>, RequestDetails) - Static method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

forHttp() - Static method in class ca.uhn.fhir.rest.server.ApacheProxyAddressStrategy

Static factory for instance using http://

forHttps() - Static method in class ca.uhn.fhir.rest.server.ApacheProxyAddressStrategy

Static factory for instance using https://

forTenantIds(String...) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRuleOpClassifierFinished

forTenantIds(Collection<String>) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRuleOpClassifierFinished

fromLongList(List<Long>) - Static method in class ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId

fullyQualifyResourceIdOrReturnNull(IRestfulServerDefaults, IBaseResource, String, IIdType) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

G

getAddProfileTag() - Method in interface ca.uhn.fhir.rest.server.IRestfulServerDefaults

Deprecated.

As of HAPI FHIR 1.5, this property has been moved to FhirContext.setAddProfileTagWhenEncoding(AddProfileTagEnum)

getAddProfileTag() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Deprecated.

As of HAPI FHIR 1.5, this property has been moved to FhirContext.setAddProfileTagWhenEncoding(AddProfileTagEnum)

getAddResponseOutcomeHeaderOnSeverity() - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

If the validation produces a result with at least the given severity, a header with the name specified by BaseValidatingInterceptor.setResponseOutcomeHeaderName(String) will be added containing a JSON encoded OperationOutcome resource containing the validation results.

getAllowableParamAnnotations() - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

getAllowableParamAnnotations() - Method in class ca.uhn.fhir.rest.server.method.ReadMethodBinding

getAllResources() - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

getAlreadySeenResourcesMap(RequestDetails, String) - Static method in class ca.uhn.fhir.rest.server.interceptor.consent.ConsentInterceptor

getAttribute(String) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

Returns the attribute map for this request.

getAttribute(String) - Method in class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

getBundleInclusionRule() - Method in interface ca.uhn.fhir.rest.api.server.IRestfulServer

getBundleInclusionRule() - Method in class ca.uhn.fhir.rest.server.RestfulServer

getByteStreamRequestContents() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getByteStreamRequestContents() - Method in class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

getCharset() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

Return the charset as defined by the header contenttype.

getCharset() - Method in class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

getCompartmentName() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getCompleteUrl() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getConditionalUrl(RestOperationTypeEnum) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

Returns the conditional URL if this request has one, or null otherwise.

getConfig() - Method in class ca.uhn.fhir.rest.server.interceptor.CorsInterceptor

Gets the CORS configuration

getConformanceDate() - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

Get the date that will be specified in the conformance profile exported by this server.

getContentType() - Method in class ca.uhn.fhir.rest.server.RestfulServerUtils.ResponseEncoding

getContext() - Method in class ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails

Deprecated.

getContext() - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

getContext() - Method in class ca.uhn.fhir.rest.server.method.OperationParameter

getCountCreate() - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

This method returns a simple operation count.

getCountDelete() - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

This method returns a simple operation count.

getCountRead() - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

This method returns a simple operation count.

getCountSearch() - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

This method returns a simple operation count.

getCountUpdate() - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

This method returns a simple operation count.

getCurrentPageId() - Method in interface ca.uhn.fhir.rest.api.server.IBundleProvider

If this method is implemented, provides an ID for the current page of results.

getCurrentPageId() - Method in class ca.uhn.fhir.rest.server.BundleProviderWithNamedPages

getDecision() - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor.Verdict

getDeclaredTypes() - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

getDefaultPageSize() - Method in class ca.uhn.fhir.rest.server.BasePagingProvider

getDefaultPageSize() - Method in interface ca.uhn.fhir.rest.server.IPagingProvider

getDefaultPolicy() - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

The default policy if no rules have been found to apply.

getDefaultPreferReturn() - Method in interface ca.uhn.fhir.rest.api.server.IRestfulServer

getDefaultPreferReturn() - Method in class ca.uhn.fhir.rest.server.RestfulServer

By default, server create/update/patch/transaction methods return a copy of the resource as it was stored.

getDefaultResponseEncoding() - Method in interface ca.uhn.fhir.rest.server.IRestfulServerDefaults

getDefaultResponseEncoding() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Returns the default encoding to return (XML/JSON) if an incoming request does not specify a preference (either with the _format URL parameter, or with an Accept header in the request.

getDescription() - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

getDescription() - Method in class ca.uhn.fhir.rest.server.method.SearchMethodBinding

getDescription() - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

getElementsSupport() - Method in interface ca.uhn.fhir.rest.server.IRestfulServerDefaults

getElementsSupport() - Method in class ca.uhn.fhir.rest.server.RestfulServer

getElementsValueOrNull(RequestDetails, boolean) - Static method in class ca.uhn.fhir.rest.server.method.ElementsParameter

getEncoding() - Method in class ca.uhn.fhir.rest.server.RestfulServerUtils.ResponseEncoding

getErrorMessageFormat() - Method in class ca.uhn.fhir.rest.server.interceptor.LoggingInterceptor

Get the log message format to be used when logging exceptions

getETagSupport() - Method in interface ca.uhn.fhir.rest.server.IRestfulServerDefaults

getETagSupport() - Method in class ca.uhn.fhir.rest.server.RestfulServer

getFhirContext() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

Returns the HAPI FHIR Context associated with this request

getFhirContext() - Method in interface ca.uhn.fhir.rest.server.IRestfulServerDefaults

Gets the FhirContext associated with this server.

getFhirContext() - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

getFhirContext() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Gets the FhirContext associated with this server.

getFhirContext() - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

Gets the FhirContext associated with this server.

getFhirContext() - Method in class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

getFhirServerBase() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

The fhir server base url, independant of the query being executed

getFixedConditionalUrl() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getFlags() - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

This property configures any flags affecting how authorization is applied.

getHeader(String) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getHeader(String) - Method in class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

getHeader(String) - Method in class ca.uhn.fhir.rest.server.servlet.ServletSubRequestDetails

getHeaderName() - Method in class ca.uhn.fhir.rest.server.interceptor.CaptureResourceSourceFromHeaderInterceptor

Provides the header name to examine in incoming requests.

getHeaders() - Method in interface ca.uhn.fhir.rest.api.server.IRestfulResponse

getHeaders() - Method in class ca.uhn.fhir.rest.server.RestfulResponse

Get the http headers

getHeaders() - Method in class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

getHeaders(String) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getHeaders(String) - Method in class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

getHeaders(String) - Method in class ca.uhn.fhir.rest.server.servlet.ServletSubRequestDetails

getId() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getId() - Method in class ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId

getId() - Method in class ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails

Deprecated.

Returns the ID of the incoming request (typically this is from the request URL)

getIdAsLong() - Method in class ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId

getIdParameterIndex() - Method in class ca.uhn.fhir.rest.server.method.BaseOutcomeReturningMethodBindingWithResourceIdButNoResourceBody

getImplementationDescription() - Method in class ca.uhn.fhir.rest.server.RestfulServer

getImplementationDescription() - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

Get the implementationDescription

getIncludes() - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

getInputStream() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

Retrieves the body of the request as binary data.

getInputStream() - Method in class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

getInterceptorBroadcaster() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

Returns an invoker that can be called from user code to advise the server interceptors of any nested operations being invoked within operations.

getInterceptors_() - Method in interface ca.uhn.fhir.rest.server.IRestfulServerDefaults

Returns the list of interceptors registered against this server

getInterceptors_() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Deprecated.

As of HAPI FHIR 3.8.0, use RestfulServer.getInterceptorService() to access the interceptor service. You can register and unregister interceptors using this service.

getInterceptorService() - Method in interface ca.uhn.fhir.rest.server.IRestfulServerDefaults

Returns the interceptor service for this server

getInterceptorService() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Returns the interceptor registry for this service.

getList() - Method in class ca.uhn.fhir.rest.server.SimpleBundleProvider

Returns the results stored in this provider

getLowestCommonSuperclass() - Method in class ca.uhn.fhir.rest.server.CommonResourceSupertypeScanner

getMatchingOperation() - Method in class ca.uhn.fhir.rest.server.method.CreateMethodBinding

getMatchingOperation() - Method in class ca.uhn.fhir.rest.server.method.DeleteMethodBinding

getMatchingOperation() - Method in class ca.uhn.fhir.rest.server.method.PatchMethodBinding

getMatchingOperation() - Method in class ca.uhn.fhir.rest.server.method.UpdateMethodBinding

getMax() - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding.ReturnType

getMax() - Method in class ca.uhn.fhir.rest.server.method.OperationParameter

getMaximumHeaderLength() - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

The maximum length for an individual header.

getMaximumPageSize() - Method in class ca.uhn.fhir.rest.server.BasePagingProvider

getMaximumPageSize() - Method in interface ca.uhn.fhir.rest.server.IPagingProvider

getMethod() - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

getMethod(RequestDetails) - Method in class ca.uhn.fhir.rest.server.ResourceBinding

getMethodBindings() - Method in class ca.uhn.fhir.rest.server.ResourceBinding

getMethodReturnType() - Method in class ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding

getMin() - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding.ReturnType

getMin() - Method in class ca.uhn.fhir.rest.server.method.OperationParameter

getMode() - Method in class ca.uhn.fhir.rest.server.method.ResourceParameter

getName() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRule

Returns a name for this rule, to be used in logs and error messages

getName() - Method in class ca.uhn.fhir.rest.server.method.BaseQueryParameter

getName() - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

Returns the name of the operation, starting with "$"

getName() - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding.ReturnType

getName() - Method in class ca.uhn.fhir.rest.server.method.OperationParameter

getName() - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

getNamedSearchMethodBindingToName() - Method in class ca.uhn.fhir.rest.server.Bindings

getNameToSharedSupertype() - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

getNewParser(FhirContext, FhirVersionEnum, RequestDetails) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

getNextPageId() - Method in interface ca.uhn.fhir.rest.api.server.IBundleProvider

If this method is implemented, provides an ID for the next page of results.

getNextPageId() - Method in class ca.uhn.fhir.rest.server.BundleProviderWithNamedPages

getOperation() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getOperationBindingToName() - Method in class ca.uhn.fhir.rest.server.Bindings

getOperationNameToBindings() - Method in class ca.uhn.fhir.rest.server.Bindings

getOperationOutcome() - Method in class ca.uhn.fhir.rest.server.interceptor.consent.ConsentOutcome

getOrCreateRequestId(HttpServletRequest) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Reads a requet ID from the request headers via the Constants.HEADER_REQUEST_ID header, or generates one if none is supplied.

getOrCreateUserData(String, Supplier<T>) - Method in class ca.uhn.fhir.rest.api.server.storage.TransactionDetails

Fetches the existing value in the user data map, or uses theSupplier to create a new object and puts that in the map, and returns it

getPage() - Method in class ca.uhn.fhir.rest.server.PageProvider

getPagingProvider() - Method in interface ca.uhn.fhir.rest.api.server.IRestfulServer

getPagingProvider() - Method in interface ca.uhn.fhir.rest.server.IRestfulServerDefaults

Returns the paging provider for this server

getPagingProvider() - Method in class ca.uhn.fhir.rest.server.RestfulServer

getParameters() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getParameters() - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

getParamType() - Method in class ca.uhn.fhir.rest.server.method.BaseQueryParameter

getParamType() - Method in class ca.uhn.fhir.rest.server.method.OperationParameter

getParamType() - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

getPlainProviders() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Provides the non-resource specific providers which implement method calls on this server

getPreviousPageId() - Method in interface ca.uhn.fhir.rest.api.server.IBundleProvider

If this method is implemented, provides an ID for the previous page of results.

getPreviousPageId() - Method in class ca.uhn.fhir.rest.server.BundleProviderWithNamedPages

getProvider() - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

getPublished() - Method in interface ca.uhn.fhir.rest.api.server.IBundleProvider

Returns the instant as of which this result was created.

getPublished() - Method in class ca.uhn.fhir.rest.server.SimpleBundleProvider

getQualifierBlacklist() - Method in class ca.uhn.fhir.rest.server.method.BaseQueryParameter

Returns null if blacklist is "none"

getQualifierBlacklist() - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

getQualifierWhitelist() - Method in class ca.uhn.fhir.rest.server.method.BaseQueryParameter

Returns null if whitelist is "all"

getQualifierWhitelist() - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

getQueryName() - Method in class ca.uhn.fhir.rest.server.method.SearchMethodBinding

getQueryParameters() - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

getReader() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

Retrieves the body of the request as character data using a BufferedReader.

getReader() - Method in class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

getRequestContentsIfLoaded() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

Returns the request contents if they were loaded, returns null otherwise

getRequestDetails() - Method in class ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails

Deprecated.

Returns the request details associated with this request

getRequestDetails() - Method in class ca.uhn.fhir.rest.server.interceptor.ResponseSizeCapturingInterceptor.Result

getRequestDetails() - Method in class ca.uhn.fhir.rest.server.RestfulResponse

Get the requestDetails

getRequestId() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getRequestIncludesFromParams(Object[]) - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

getRequestPath() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

The part of the request URL that comes after the server base.

getRequestPath(String, String, String) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Allows users of RestfulServer to override the getRequestPath method to let them build their custom request path implementation

getRequestResource(RequestDetails, TransactionParameter.ParamStyle, Class<? extends IBaseResource>) - Method in interface ca.uhn.fhir.rest.server.IRestfulServerUtil

getRequestStopwatch() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getRequestType() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getResolvedResourceIds() - Method in class ca.uhn.fhir.rest.api.server.storage.TransactionDetails

A Resolved Resource ID is a mapping between a resource ID (e.g.

getResource() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

Returns the request resource (as provided in the request body) if it has been parsed.

getResource() - Method in class ca.uhn.fhir.rest.server.interceptor.consent.ConsentOutcome

getResource() - Method in class ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails

Deprecated.

For requests where a resource is passed from the client to the server (e.g.

getResource(int) - Method in interface ca.uhn.fhir.rest.api.server.IPreResourceAccessDetails

getResource(int) - Method in interface ca.uhn.fhir.rest.api.server.IPreResourceShowDetails

getResource(int) - Method in class ca.uhn.fhir.rest.api.server.SimplePreResourceAccessDetails

getResource(int) - Method in class ca.uhn.fhir.rest.api.server.SimplePreResourceShowDetails

getResourceBindings() - Method in class ca.uhn.fhir.rest.server.RestfulServer

getResourceBindings() - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

Get the resourceBindings

getResourceContentType() - Method in class ca.uhn.fhir.rest.server.RestfulServerUtils.ResponseEncoding

getResourceName() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getResourceName() - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

Returns the name of the resource this method handles, or null if this method is not resource specific

getResourceName() - Method in class ca.uhn.fhir.rest.server.method.BaseOutcomeReturningMethodBindingWithResourceIdButNoResourceBody

getResourceName() - Method in class ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding

getResourceName() - Method in class ca.uhn.fhir.rest.server.method.GraphQLMethodBinding

getResourceName() - Method in class ca.uhn.fhir.rest.server.ResourceBinding

getResourceParameter(RequestDetails, ResourceParameter.Mode, BaseMethodBinding<?>, Class<? extends IBaseResource>) - Method in interface ca.uhn.fhir.rest.server.IRestfulServerUtil

getResourceParameters(FhirContext, Method, Object, RestOperationTypeEnum) - Static method in class ca.uhn.fhir.rest.server.method.MethodUtil

getResourceProviderResourceName() - Method in class ca.uhn.fhir.rest.server.method.SearchMethodBinding

getResourceProviders() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Provides the resource providers for this server

getResources(int, int) - Method in interface ca.uhn.fhir.rest.api.server.IBundleProvider

Load the given collection of resources by index, plus any additional resources per the server's processing rules (e.g.

getResources(int, int) - Method in class ca.uhn.fhir.rest.server.BundleProviderWithNamedPages

getResources(int, int) - Method in class ca.uhn.fhir.rest.server.SimpleBundleProvider

getResourceType() - Method in class ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails

Deprecated.

Returns the resource type this request pertains to, or null if this request is not type specific (e.g.

getResourceType() - Method in interface ca.uhn.fhir.rest.server.IResourceProvider

Returns the type of resource returned by this provider

getResourceType() - Method in class ca.uhn.fhir.rest.server.method.ResourceParameter

getResourceType() - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

getResponse() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getResponseBundleType() - Method in class ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding

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

getResponseBundleType() - Method in class ca.uhn.fhir.rest.server.method.ConformanceMethodBinding

getResponseBundleType() - Method in class ca.uhn.fhir.rest.server.method.HistoryMethodBinding

getResponseBundleType() - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

getResponseBundleType() - Method in class ca.uhn.fhir.rest.server.method.PageMethodBinding

getResponseBundleType() - Method in class ca.uhn.fhir.rest.server.method.ReadMethodBinding

getResponseBundleType() - Method in class ca.uhn.fhir.rest.server.method.SearchMethodBinding

getResponseBundleType() - Method in class ca.uhn.fhir.rest.server.method.TransactionMethodBinding

getResponseCode() - Method in class ca.uhn.fhir.rest.api.server.ResponseDetails

getResponseOutcomeHeaderName() - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

The name of the header specified by BaseValidatingInterceptor.setAddResponseOutcomeHeaderOnSeverity(ResultSeverityEnum)

getResponseResource() - Method in class ca.uhn.fhir.rest.api.server.ResponseDetails

Get the resource which will be returned to the client

getResponseWriter(int, String, String, String, boolean) - Method in interface ca.uhn.fhir.rest.api.server.IRestfulResponse

getResponseWriter(int, String, String, String, boolean) - Method in class ca.uhn.fhir.rest.server.servlet.ServletRestfulResponse

getRestOperationType() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getRestOperationType() - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

getRestOperationType() - Method in class ca.uhn.fhir.rest.server.method.ConformanceMethodBinding

getRestOperationType() - Method in class ca.uhn.fhir.rest.server.method.CreateMethodBinding

getRestOperationType() - Method in class ca.uhn.fhir.rest.server.method.DeleteMethodBinding

getRestOperationType() - Method in class ca.uhn.fhir.rest.server.method.GraphQLMethodBinding

getRestOperationType() - Method in class ca.uhn.fhir.rest.server.method.HistoryMethodBinding

getRestOperationType() - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

getRestOperationType() - Method in class ca.uhn.fhir.rest.server.method.PageMethodBinding

getRestOperationType() - Method in class ca.uhn.fhir.rest.server.method.PatchMethodBinding

getRestOperationType() - Method in class ca.uhn.fhir.rest.server.method.ReadMethodBinding

getRestOperationType() - Method in class ca.uhn.fhir.rest.server.method.SearchMethodBinding

getRestOperationType() - Method in class ca.uhn.fhir.rest.server.method.TransactionMethodBinding

getRestOperationType() - Method in class ca.uhn.fhir.rest.server.method.UpdateMethodBinding

getRestOperationType(RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

Determine which operation is being fired for a specific request

getRestOperationType(RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

getRestOperationType(RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.ReadMethodBinding

getReturnParams() - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

getReturnType() - Method in class ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding

getReturnType() - Method in class ca.uhn.fhir.rest.server.method.ConformanceMethodBinding

getReturnType() - Method in class ca.uhn.fhir.rest.server.method.HistoryMethodBinding

getReturnType() - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

getReturnType() - Method in class ca.uhn.fhir.rest.server.method.PageMethodBinding

getReturnType() - Method in class ca.uhn.fhir.rest.server.method.ReadMethodBinding

getReturnType() - Method in class ca.uhn.fhir.rest.server.method.SearchMethodBinding

getReturnType() - Method in class ca.uhn.fhir.rest.server.method.TransactionMethodBinding

getSearchNameToBindings() - Method in class ca.uhn.fhir.rest.server.Bindings

getSearchParameters() - Method in interface ca.uhn.fhir.rest.server.IDynamicSearchResourceProvider

getSearchParamType() - Method in class ca.uhn.fhir.rest.server.method.OperationParameter

getSecondaryOperation() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getServer() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getServer() - Method in class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

getServerAddressStrategy() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Get the server address strategy, which is used to determine what base URL to provide clients to refer to this server.

getServerAddressStrategy() - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

Get the serverAddressStrategy

getServerBaseForRequest() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

Returns the server base URL (with no trailing '/') for a given request

getServerBaseForRequest() - Method in class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

getServerBaseForRequest(ServletRequestDetails) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Returns the server base URL (with no trailing '/') for a given request

getServerBindings() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Returns the method bindings for this server which are not specific to any particular resource type.

getServerBindings() - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

Get the serverBindings

getServerConfiguration(RequestDetails) - Method in class ca.uhn.fhir.rest.server.util.BaseServerCapabilityStatementProvider

getServerConformance(HttpServletRequest, RequestDetails) - Method in interface ca.uhn.fhir.rest.server.IServerConformanceProvider

Actually create and return the conformance statement See the class documentation for an important note if you are extending this class

getServerConformanceProvider() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Returns the server conformance provider, which is the provider that is used to generate the server's conformance (metadata) statement if one has been explicitly defined.

getServerName() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Gets the server's name, as exported in conformance profiles exported by the server.

getServerName() - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

Get the serverName

getServerVersion() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Gets the server's version, as exported in conformance profiles exported by the server.

getServerVersion() - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

Get the serverVersion

getServletRequest() - Method in class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

getServletRequest() - Method in class ca.uhn.fhir.rest.server.servlet.ServletSubRequestDetails

getServletResponse() - Method in class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

getServletResponse() - Method in class ca.uhn.fhir.rest.server.servlet.ServletSubRequestDetails

getServletSubRequestDetails(ServletRequestDetails, String, ArrayListMultimap<String, String>) - Static method in class ca.uhn.fhir.rest.server.util.ServletRequestUtil

getStatus() - Method in class ca.uhn.fhir.rest.server.interceptor.consent.ConsentOutcome

getStoredResources() - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

Returns an unmodifiable list containing the current version of all resources stored in this provider

getSummaryValueOrNull(RequestDetails) - Static method in class ca.uhn.fhir.rest.server.method.SummaryEnumParameter

getTenantId() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getTransactionDate() - Method in class ca.uhn.fhir.rest.api.server.storage.TransactionDetails

This is the wall-clock time that a given transaction started.

getTransactionGuid() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getType() - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding.ReturnType

getType() - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

getUnqualifiedToQualifiedNames() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

getUserData() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

Returns a map which can be used to hold any user specific data to pass it from one part of the request handling chain to another.

getUserData() - Method in class ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails

Deprecated.

Returns the same map which was

getUserData() - Method in class ca.uhn.fhir.rest.server.servlet.ServletSubRequestDetails

getUserData(String) - Method in class ca.uhn.fhir.rest.api.server.storage.TransactionDetails

Gets an arbitraty object that will last the lifetime of the current transaction

getUuid() - Method in interface ca.uhn.fhir.rest.api.server.IBundleProvider

Returns the UUID associated with this search.

getUuid() - Method in class ca.uhn.fhir.rest.server.SimpleBundleProvider

getValidatorModules() - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

getValue() - Method in class ca.uhn.fhir.rest.server.HardcodedServerAddressStrategy

getWrittenChars() - Method in class ca.uhn.fhir.rest.server.interceptor.ResponseSizeCapturingInterceptor.Result

graphQL() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRule

Allow a GraphQL query

GraphQLMethodBinding - Class in ca.uhn.fhir.rest.server.method

GraphQLMethodBinding(Method, FhirContext, Object) - Constructor for class ca.uhn.fhir.rest.server.method.GraphQLMethodBinding

GraphQLQueryParameter - Class in ca.uhn.fhir.rest.server.method

GraphQLQueryParameter() - Constructor for class ca.uhn.fhir.rest.server.method.GraphQLQueryParameter

H

handleDeny(RequestDetails, AuthorizationInterceptor.Verdict) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

Handle an access control verdict of PolicyEnum.DENY.

handleDeny(AuthorizationInterceptor.Verdict) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

This method should not be overridden.

handleException(RequestDetails, BaseServerResponseException) - Method in class ca.uhn.fhir.rest.server.interceptor.ExceptionHandlingInterceptor

handleException(RequestDetails, BaseServerResponseException, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.ExceptionHandlingInterceptor

handleException(RequestDetails, BaseServerResponseException, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.InterceptorAdapter

handleException(RequestDetails, BaseServerResponseException, HttpServletRequest, HttpServletResponse) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerInterceptor

This method is called upon any exception being thrown within the server's request processing code.

handleException(RequestDetails, BaseServerResponseException, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.LoggingInterceptor

handleException(RequestDetails, BaseServerResponseException, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.ResponseHighlighterInterceptor

handleRequest(RequestTypeEnum, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.RestfulServer

handlesMissing() - Method in class ca.uhn.fhir.rest.server.method.BaseQueryParameter

Parameter should return true if BaseQueryParameter.parse(FhirContext, List) should be called even if the query string contained no values for the given parameter

handlesMissing() - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

HardcodedServerAddressStrategy - Class in ca.uhn.fhir.rest.server

Server address strategy which simply returns a hardcoded URL

HardcodedServerAddressStrategy() - Constructor for class ca.uhn.fhir.rest.server.HardcodedServerAddressStrategy

HardcodedServerAddressStrategy(String) - Constructor for class ca.uhn.fhir.rest.server.HardcodedServerAddressStrategy

hashCode() - Method in class ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId

hashCode() - Method in class ca.uhn.fhir.rest.server.ResourceBinding

HashMapResourceProvider<T extends org.hl7.fhir.instance.model.api.IBaseResource> - Class in ca.uhn.fhir.rest.server.provider

This class is a simple implementation of the resource provider interface that uses a HashMap to store all resources in memory.

HashMapResourceProvider(FhirContext, Class<T>) - Constructor for class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

Constructor

historyInstance(IIdType, RequestDetails) - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

HistoryMethodBinding - Class in ca.uhn.fhir.rest.server.method

HistoryMethodBinding(Method, FhirContext, Object) - Constructor for class ca.uhn.fhir.rest.server.method.HistoryMethodBinding

historyType() - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

hookCascadeDeleteForConflict(RequestDetails, Pointcut, IBaseResource) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

hookOutgoingResponse(RequestDetails, IBaseResource, Pointcut) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

hookPreShow(RequestDetails, IPreResourceShowDetails, Pointcut) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

hookResourcePreCreate(RequestDetails, IBaseResource, Pointcut) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

hookResourcePreDelete(RequestDetails, IBaseResource, Pointcut) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

hookResourcePreUpdate(RequestDetails, IBaseResource, IBaseResource, Pointcut) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

I

IAuthRule - Interface in ca.uhn.fhir.rest.server.interceptor.auth

Note: At this time, this interface is considered internal API to HAPI FHIR, and is subject to change without warning.

IAuthRuleBuilder - Interface in ca.uhn.fhir.rest.server.interceptor.auth

Used by AuthorizationInterceptor in order to allow user code to define authorization rules.

IAuthRuleBuilderAppliesTo<T> - Interface in ca.uhn.fhir.rest.server.interceptor.auth

IAuthRuleBuilderGraphQL - Interface in ca.uhn.fhir.rest.server.interceptor.auth

IAuthRuleBuilderOperation - Interface in ca.uhn.fhir.rest.server.interceptor.auth

IAuthRuleBuilderOperationNamed - Interface in ca.uhn.fhir.rest.server.interceptor.auth

IAuthRuleBuilderOperationNamedAndScoped - Interface in ca.uhn.fhir.rest.server.interceptor.auth

IAuthRuleBuilderPatch - Interface in ca.uhn.fhir.rest.server.interceptor.auth

IAuthRuleBuilderRule - Interface in ca.uhn.fhir.rest.server.interceptor.auth

IAuthRuleBuilderRuleConditional - Interface in ca.uhn.fhir.rest.server.interceptor.auth

IAuthRuleBuilderRuleConditionalClassifier - Interface in ca.uhn.fhir.rest.server.interceptor.auth

IAuthRuleBuilderRuleOp - Interface in ca.uhn.fhir.rest.server.interceptor.auth

IAuthRuleBuilderRuleOpClassifier - Interface in ca.uhn.fhir.rest.server.interceptor.auth

IAuthRuleBuilderRuleOpClassifierFinished - Interface in ca.uhn.fhir.rest.server.interceptor.auth

IAuthRuleBuilderRuleOpClassifierFinishedWithTenantId - Interface in ca.uhn.fhir.rest.server.interceptor.auth

IAuthRuleBuilderRuleOpDelete - Interface in ca.uhn.fhir.rest.server.interceptor.auth

IAuthRuleBuilderRuleTransaction - Interface in ca.uhn.fhir.rest.server.interceptor.auth

IAuthRuleBuilderRuleTransactionOp - Interface in ca.uhn.fhir.rest.server.interceptor.auth

IAuthRuleFinished - Interface in ca.uhn.fhir.rest.server.interceptor.auth

IAuthRuleTester - Interface in ca.uhn.fhir.rest.server.interceptor.auth

Allows user-supplied logic for authorization rules.

IBundleProvider - Interface in ca.uhn.fhir.rest.api.server

ICachedSearchDetails - Interface in ca.uhn.fhir.rest.server.util

IConsentContextServices - Interface in ca.uhn.fhir.rest.server.interceptor.consent

IConsentService - Interface in ca.uhn.fhir.rest.server.interceptor.consent

IDynamicSearchResourceProvider - Interface in ca.uhn.fhir.rest.server

This is still an experimental API - It isn't meant for public consumption yet.

IFhirVersionServer - Interface in ca.uhn.fhir.rest.api.server

This class is the server specific equivalent to IFhirVersion

IncomingRequestAddressStrategy - Class in ca.uhn.fhir.rest.server

Determines the server's base using the incoming request

IncomingRequestAddressStrategy() - Constructor for class ca.uhn.fhir.rest.server.IncomingRequestAddressStrategy

incomingRequestPostProcessed(RequestDetails, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.SearchNarrowingInterceptor

incomingRequestPostProcessed(RequestDetails, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.InterceptorAdapter

incomingRequestPostProcessed(RequestDetails, HttpServletRequest, HttpServletResponse) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerInterceptor

This method is called just before the actual implementing server method is invoked.

incomingRequestPostProcessed(RequestDetails, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.RequestValidatingInterceptor

incomingRequestPostProcessed(RequestDetails, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.VerboseLoggingInterceptor

incomingRequestPreHandled(RestOperationTypeEnum, IServerInterceptor.ActionRequestDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.InterceptorAdapter

incomingRequestPreHandled(RestOperationTypeEnum, IServerInterceptor.ActionRequestDetails) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerInterceptor

Invoked before an incoming request is processed.

incomingRequestPreHandled(RequestDetails, Pointcut) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

incomingRequestPreHandled(ServletRequestDetails, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.SearchNarrowingInterceptor

incomingRequestPreProcessed(HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.BanUnsupportedHttpMethodsInterceptor

incomingRequestPreProcessed(HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.CorsInterceptor

incomingRequestPreProcessed(HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.InterceptorAdapter

incomingRequestPreProcessed(HttpServletRequest, HttpServletResponse) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerInterceptor

This method is called before any other processing takes place for each incoming request.

incomingServerRequestMatchesMethod(RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

incomingServerRequestMatchesMethod(RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.ConformanceMethodBinding

incomingServerRequestMatchesMethod(RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.GraphQLMethodBinding

incomingServerRequestMatchesMethod(RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.HistoryMethodBinding

incomingServerRequestMatchesMethod(RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

incomingServerRequestMatchesMethod(RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.PageMethodBinding

incomingServerRequestMatchesMethod(RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.PatchMethodBinding

incomingServerRequestMatchesMethod(RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.ReadMethodBinding

incomingServerRequestMatchesMethod(RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.SearchMethodBinding

incomingServerRequestMatchesMethod(RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.TransactionMethodBinding

inCompartment(String, Collection<? extends IIdType>) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRuleOpClassifier

Rule applies to resources in the given compartment.

inCompartment(String, IIdType) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRuleOpClassifier

Rule applies to resources in the given compartment.

init() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Initializes the server.

initialize() - Method in class ca.uhn.fhir.rest.server.RestfulServer

This method may be overridden by subclasses to do perform initialization that needs to be performed prior to the server being used.

initializeTypes(Method, Class<? extends Collection<?>>, Class<? extends Collection<?>>, Class<?>) - Method in class ca.uhn.fhir.rest.server.method.BaseQueryParameter

initializeTypes(Method, Class<? extends Collection<?>>, Class<? extends Collection<?>>, Class<?>) - Method in class ca.uhn.fhir.rest.server.method.CountParameter

initializeTypes(Method, Class<? extends Collection<?>>, Class<? extends Collection<?>>, Class<?>) - Method in class ca.uhn.fhir.rest.server.method.ElementsParameter

initializeTypes(Method, Class<? extends Collection<?>>, Class<? extends Collection<?>>, Class<?>) - Method in class ca.uhn.fhir.rest.server.method.GraphQLQueryParameter

initializeTypes(Method, Class<? extends Collection<?>>, Class<? extends Collection<?>>, Class<?>) - Method in interface ca.uhn.fhir.rest.server.method.IParameter

initializeTypes(Method, Class<? extends Collection<?>>, Class<? extends Collection<?>>, Class<?>) - Method in class ca.uhn.fhir.rest.server.method.OperationParameter

initializeTypes(Method, Class<? extends Collection<?>>, Class<? extends Collection<?>>, Class<?>) - Method in class ca.uhn.fhir.rest.server.method.RawParamsParameter

initializeTypes(Method, Class<? extends Collection<?>>, Class<? extends Collection<?>>, Class<?>) - Method in class ca.uhn.fhir.rest.server.method.RequestDetailsParameter

initializeTypes(Method, Class<? extends Collection<?>>, Class<? extends Collection<?>>, Class<?>) - Method in class ca.uhn.fhir.rest.server.method.ResourceParameter

initializeTypes(Method, Class<? extends Collection<?>>, Class<? extends Collection<?>>, Class<?>) - Method in class ca.uhn.fhir.rest.server.method.SortParameter

initializeTypes(Method, Class<? extends Collection<?>>, Class<? extends Collection<?>>, Class<?>) - Method in class ca.uhn.fhir.rest.server.method.SummaryEnumParameter

initializeTypes(Method, Class<? extends Collection<?>>, Class<? extends Collection<?>>, Class<?>) - Method in class ca.uhn.fhir.rest.server.method.TransactionParameter

instance(String) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRuleOp

Rule applies to the resource with the given ID (e.g.

instance(IIdType) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRuleOp

Rule applies to the resource with the given ID (e.g.

instances(Collection<IIdType>) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRuleOp

Rule applies to the resource with the given ID (e.g.

InterceptorAdapter - Class in ca.uhn.fhir.rest.server.interceptor

Base class for IServerInterceptor implementations.

InterceptorAdapter() - Constructor for class ca.uhn.fhir.rest.server.interceptor.InterceptorAdapter

InterceptorOrders - Class in ca.uhn.fhir.rest.server.interceptor

interceptOutgoingResponse(RequestDetails, ResponseDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.consent.ConsentInterceptor

interceptPreAccess(RequestDetails, IPreResourceAccessDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.consent.ConsentInterceptor

interceptPreCheckForCachedSearch(RequestDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.consent.ConsentInterceptor

interceptPreHandled(RequestDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.consent.ConsentInterceptor

interceptPreSearchRegistered(RequestDetails, ICachedSearchDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.consent.ConsentInterceptor

interceptPreShow(RequestDetails, IPreResourceShowDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.consent.ConsentInterceptor

invokeServer(IRestfulServer<?>, RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

invokeServer(IRestfulServer<?>, RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding

invokeServer(IRestfulServer<?>, RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.GraphQLMethodBinding

invokeServer(IRestfulServer<?>, RequestDetails) - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

invokeServer(IRestfulServer<?>, RequestDetails, Object[]) - Method in class ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding

invokeServer(IRestfulServer<?>, RequestDetails, Object[]) - Method in class ca.uhn.fhir.rest.server.method.ConformanceMethodBinding

invokeServer(IRestfulServer<?>, RequestDetails, Object[]) - Method in class ca.uhn.fhir.rest.server.method.HistoryMethodBinding

invokeServer(IRestfulServer<?>, RequestDetails, Object[]) - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

invokeServer(IRestfulServer<?>, RequestDetails, Object[]) - Method in class ca.uhn.fhir.rest.server.method.PageMethodBinding

invokeServer(IRestfulServer<?>, RequestDetails, Object[]) - Method in class ca.uhn.fhir.rest.server.method.ReadMethodBinding

invokeServer(IRestfulServer<?>, RequestDetails, Object[]) - Method in class ca.uhn.fhir.rest.server.method.SearchMethodBinding

invokeServer(IRestfulServer<?>, RequestDetails, Object[]) - Method in class ca.uhn.fhir.rest.server.method.TransactionMethodBinding

invokeServerMethod(IRestfulServer<?>, RequestDetails, Object[]) - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

IPagingProvider - Interface in ca.uhn.fhir.rest.server

IParameter - Interface in ca.uhn.fhir.rest.server.method

IPreResourceAccessDetails - Interface in ca.uhn.fhir.rest.api.server

This object is an abstraction for a server response that is going to return one or more resources to the user.

IPreResourceShowDetails - Interface in ca.uhn.fhir.rest.api.server

This interface is a parameter type for the Pointcut.STORAGE_PRESHOW_RESOURCES hook.

IResourceProvider - Interface in ca.uhn.fhir.rest.server

IResourceProviderFactoryObserver - Interface in ca.uhn.fhir.rest.server.provider

IRestfulHeader - Interface in ca.uhn.fhir.rest.server.method

IRestfulResponse - Interface in ca.uhn.fhir.rest.api.server

IRestfulServer<T extends RequestDetails> - Interface in ca.uhn.fhir.rest.api.server

IRestfulServerDefaults - Interface in ca.uhn.fhir.rest.server

IRestfulServerUtil - Interface in ca.uhn.fhir.rest.server

IRuleApplier - Interface in ca.uhn.fhir.rest.server.interceptor.auth

isAddContentLocationHeader() - Method in class ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding

Should the response include a Content-Location header.

isAddContentLocationHeader() - Method in class ca.uhn.fhir.rest.server.method.SearchMethodBinding

isAddValidationResultsToResponseOperationOutcome() - Method in class ca.uhn.fhir.rest.server.interceptor.RequestValidatingInterceptor

If set to true (default is true), the validation results will be added to the OperationOutcome being returned to the client, unless the response being returned is not an OperationOutcome to begin with (e.g.

isCanOperateAtInstanceLevel() - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

isCanOperateAtServerLevel() - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

isCanOperateAtTypeLevel() - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

isDefaultPrettyPrint() - Method in interface ca.uhn.fhir.rest.server.IRestfulServerDefaults

Should the server "pretty print" responses by default (requesting clients can always override this default by supplying an Accept header in the request, or a _pretty parameter in the request URL.

isDefaultPrettyPrint() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Should the server "pretty print" responses by default (requesting clients can always override this default by supplying an Accept header in the request, or a _pretty parameter in the request URL.

isDontReturnResourceAtIndex(int) - Method in class ca.uhn.fhir.rest.api.server.SimplePreResourceAccessDetails

isEmpty() - Method in interface ca.uhn.fhir.rest.api.server.IBundleProvider

This method returns true if the bundle provider knows that at least one result exists.

IServerAddressStrategy - Interface in ca.uhn.fhir.rest.server

Provides the server base for a given incoming request.

IServerConformanceProvider<T extends org.hl7.fhir.instance.model.api.IBaseResource> - Interface in ca.uhn.fhir.rest.server

IServerInterceptor - Interface in ca.uhn.fhir.rest.server.interceptor

Provides methods to intercept requests and responses.

IServerInterceptor.ActionRequestDetails - Class in ca.uhn.fhir.rest.server.interceptor

Deprecated.

This class doesn't bring anything that can't be done with RequestDetails. That class should be used instead. Deprecated in 4.0.0

IServerMethodBinding - Interface in ca.uhn.fhir.rest.api.server

IServerOperationInterceptor - Interface in ca.uhn.fhir.rest.server.interceptor

Deprecated.

Ths interface is no longer neccessary as of HAPI FHIR 3.8.0 - You can create interceptor methods that are declared using the Hook annotation without needing to implement any interceptor

isGlobalMethod() - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

Subclasses may override to declare that they apply to all resource types

isGlobalMethod() - Method in class ca.uhn.fhir.rest.server.method.GraphQLMethodBinding

isGlobalMethod() - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

isIdempotent() - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

isIgnoreServerParsedRequestParameters() - Method in class ca.uhn.fhir.rest.server.RestfulServer

If set to true (the default is true) this server will not use the parsed request parameters (URL parameters and HTTP POST form contents) but will instead parse these values manually from the request URL and request body.

isIgnoreValidatorExceptions() - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

If set to true (default is false) this interceptor will exit immediately and allow processing to continue if the validator throws any exceptions.

isLogExceptions() - Method in class ca.uhn.fhir.rest.server.interceptor.LoggingInterceptor

Should exceptions be logged by this logger

isManualRequestMode() - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

isRequired() - Method in class ca.uhn.fhir.rest.server.method.BaseQueryParameter

isRequired() - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

isRespondGzip() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

isShowRequestHeaders() - Method in class ca.uhn.fhir.rest.server.interceptor.ResponseHighlighterInterceptor

If set to true (default is false) response will include the request headers

isShowResponseHeaders() - Method in class ca.uhn.fhir.rest.server.interceptor.ResponseHighlighterInterceptor

If set to true (default is true) response will include the response headers

isSubRequest() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

Is this request a sub-request (i.e.

isSubRequest() - Method in class ca.uhn.fhir.rest.server.servlet.ServletSubRequestDetails

isSupportsConditional() - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

Does this method have a parameter annotated with ConditionalParamBinder.

isSupportsConditionalMultiple() - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

Does this method support conditional operations over multiple objects (basically for conditional delete)

isUncompressIncomingContents() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Should the server attempt to decompress incoming request contents (default is true).

isVread() - Method in class ca.uhn.fhir.rest.server.method.ReadMethodBinding

ITenantIdentificationStrategy - Interface in ca.uhn.fhir.rest.server.tenant

iterator() - Method in class ca.uhn.fhir.rest.api.server.SimplePreResourceShowDetails

ITestingUiClientFactory - Interface in ca.uhn.fhir.rest.server.util

This interface isn't used by hapi-fhir-base, but is used by the Web Testing UI

L

lastN(ServletRequestDetails, IBaseReference, List<IBaseCoding>, List<IBaseCoding>, IPrimitiveType<Integer>) - Method in class ca.uhn.fhir.rest.server.provider.BaseLastNProvider

LIST_OF_RESOURCES - ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding.MethodReturnTypeEnum

loadRequestContents() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

loadResourceFromRequest(RequestDetails, BaseMethodBinding<?>, Class<T>) - Method in interface ca.uhn.fhir.rest.server.IRestfulServerUtil

LoggingInterceptor - Class in ca.uhn.fhir.rest.server.interceptor

Server interceptor which logs each request using a defined format

LoggingInterceptor() - Constructor for class ca.uhn.fhir.rest.server.interceptor.LoggingInterceptor

Constructor for server logging interceptor

M

markResourceAtIndexAsSubset(int) - Method in interface ca.uhn.fhir.rest.api.server.IPreResourceShowDetails

Indicates that data is being masked from within the resource at the given index.

markResourceAtIndexAsSubset(int) - Method in class ca.uhn.fhir.rest.api.server.SimplePreResourceShowDetails

massageServerBaseUrl(String, RequestDetails) - Method in interface ca.uhn.fhir.rest.server.tenant.ITenantIdentificationStrategy

Implementations may use this method to tweak the server base URL if necessary based on the tenant ID

massageServerBaseUrl(String, RequestDetails) - Method in class ca.uhn.fhir.rest.server.tenant.UrlBaseTenantIdentificationStrategy

matches(RestOperationTypeEnum, RequestDetails, IIdType, IBaseResource) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleTester

Allows user-supplied logic for authorization rules.

matchesOutput(RestOperationTypeEnum, RequestDetails, IBaseResource) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleTester

Allows user-supplied logic for authorization rules.

MEDIA_CONTENT_CONTENT_TYPE_OPT - Static variable in class ca.uhn.fhir.rest.server.interceptor.ServeMediaResourceRawInterceptor

metadata() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRule

This rules applies to the metadata operation (retrieve the server's conformance statement)

METHOD_OUTCOME - ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding.MethodReturnTypeEnum

MethodMatchEnum - Enum in ca.uhn.fhir.rest.server.method

MethodUtil - Class in ca.uhn.fhir.rest.server.method

MethodUtil() - Constructor for class ca.uhn.fhir.rest.server.method.MethodUtil

myIdToHistory - Variable in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

myIdToVersionToResourceMap - Variable in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

mySearchCount - Variable in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

myTypeHistory - Variable in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

N

named(String) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderOperation

This rule applies to the operation with the given name

newClient(FhirContext, HttpServletRequest, String) - Method in interface ca.uhn.fhir.rest.server.util.ITestingUiClientFactory

Instantiate a new client

newEmptyList() - Static method in class ca.uhn.fhir.rest.server.BundleProviders

Create a new unmodifiable empty resource list with the current time as the publish date.

newList(List<IBaseResource>) - Static method in class ca.uhn.fhir.rest.server.BundleProviders

newList(IBaseResource) - Static method in class ca.uhn.fhir.rest.server.BundleProviders

newRequestDetails() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Deprecated.

Deprecated in HAPI FHIR 4.1.0 - Users wishing to override this method should override RestfulServer.newRequestDetails(RequestTypeEnum, HttpServletRequest, HttpServletResponse) instead

newRequestDetails(RequestTypeEnum, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Subclasses may override this to customize the way that the RequestDetails object is created.

newRequestId(int) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Generate a new request ID string.

NO_NOT_PROACTIVELY_BLOCK_COMPARTMENT_READ_ACCESS - ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationFlagsEnum

If this flag is set, attempts to perform read operations (read/search/history) will be matched by the interceptor before the method handler is called.

NONE - ca.uhn.fhir.rest.server.method.MethodMatchEnum

notForTenantIds(String...) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRuleOpClassifierFinished

notForTenantIds(Collection<String>) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRuleOpClassifierFinished

notifyIncomingRequestPreHandled(RestOperationTypeEnum) - Method in class ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails

Deprecated.

This method may be invoked by user code to notify interceptors that a nested operation is being invoked which is denoted by this request details.

NULL_IMPL - Static variable in interface ca.uhn.fhir.rest.server.interceptor.consent.IConsentContextServices

Implementation of this interface that simply always throws a UnsupportedOperationException

O

onAnyInstance() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderOperationNamed

Rule applies to invocations of this operation at the instance level on any instance

onAnyType() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderOperationNamed

Rule applies to invocations of this operation at the type level on any type

onCascade() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRuleOpDelete

Specifies that this rule applies to cascading deletes as opposed to regular deletes.

onInstance(IIdType) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderOperationNamed

Rule applies to invocations of this operation at the instance level

onInstancesOfType(Class<? extends IBaseResource>) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderOperationNamed

Rule applies to invocations of this operation at the instance level on any instance of the given type

onServer() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderOperationNamed

Rule applies to invocations of this operation at the server level

onType(Class<? extends IBaseResource>) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderOperationNamed

Rule applies to invocations of this operation at the type level

operation() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRule

This rule applies to a FHIR operation (e.g.

OperationMethodBinding - Class in ca.uhn.fhir.rest.server.method

OperationMethodBinding(Class<?>, Class<? extends IBaseResource>, Method, FhirContext, Object, boolean, String, Class<? extends IBaseResource>, String, OperationParam[], BundleTypeEnum) - Constructor for class ca.uhn.fhir.rest.server.method.OperationMethodBinding

OperationMethodBinding(Class<?>, Class<? extends IBaseResource>, Method, FhirContext, Object, Operation) - Constructor for class ca.uhn.fhir.rest.server.method.OperationMethodBinding

Constructor - This is the constructor that is called when binding a standard @Operation method.

OperationMethodBinding.ReturnType - Class in ca.uhn.fhir.rest.server.method

OperationParameter - Class in ca.uhn.fhir.rest.server.method

OperationParameter(FhirContext, String, OperationParam) - Constructor for class ca.uhn.fhir.rest.server.method.OperationParameter

outgoingGraphqlResponse(RequestDetails, String, String, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.ResponseHighlighterInterceptor

outgoingResponse(RequestDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.InterceptorAdapter

outgoingResponse(RequestDetails) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerInterceptor

Deprecated.

As of HAPI FHIR 3.2.0, this method is deprecated and will be removed in a future version of HAPI FHIR.

outgoingResponse(RequestDetails, TagList) - Method in class ca.uhn.fhir.rest.server.interceptor.InterceptorAdapter

outgoingResponse(RequestDetails, TagList) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerInterceptor

Deprecated.

As of HAPI FHIR 3.2.0, this method is deprecated and will be removed in a future version of HAPI FHIR.

outgoingResponse(RequestDetails, TagList, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.InterceptorAdapter

outgoingResponse(RequestDetails, TagList, HttpServletRequest, HttpServletResponse) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerInterceptor

Deprecated.

As of HAPI FHIR 3.2.0, this method is deprecated and will be removed in a future version of HAPI FHIR.

outgoingResponse(RequestDetails, ResponseDetails, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.InterceptorAdapter

outgoingResponse(RequestDetails, ResponseDetails, HttpServletRequest, HttpServletResponse) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerInterceptor

This method is called after the server implementation method has been called, but before any attempt to stream the response back to the client.

outgoingResponse(RequestDetails, ResponseDetails, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.ResponseHighlighterInterceptor

outgoingResponse(RequestDetails, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.InterceptorAdapter

outgoingResponse(RequestDetails, HttpServletRequest, HttpServletResponse) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerInterceptor

Deprecated.

As of HAPI FHIR 3.2.0, this method is deprecated and will be removed in a future version of HAPI FHIR.

outgoingResponse(RequestDetails, IBaseResource) - Method in class ca.uhn.fhir.rest.server.interceptor.InterceptorAdapter

outgoingResponse(RequestDetails, IBaseResource) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerInterceptor

Deprecated.

As of HAPI FHIR 3.2.0, this method is deprecated and will be removed in a future version of HAPI FHIR.

outgoingResponse(RequestDetails, IBaseResource) - Method in class ca.uhn.fhir.rest.server.interceptor.RequestValidatingInterceptor

outgoingResponse(RequestDetails, IBaseResource) - Method in class ca.uhn.fhir.rest.server.interceptor.ResponseValidatingInterceptor

outgoingResponse(RequestDetails, IBaseResource, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.InterceptorAdapter

outgoingResponse(RequestDetails, IBaseResource, HttpServletRequest, HttpServletResponse) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerInterceptor

Deprecated.

As of HAPI FHIR 3.3.0, this method has been deprecated in favour of IServerInterceptor.outgoingResponse(RequestDetails, ResponseDetails, HttpServletRequest, HttpServletResponse) and will be removed in a future version of HAPI FHIR.

outgoingResponse(RequestDetails, IBaseResource, HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.interceptor.ServeMediaResourceRawInterceptor

P

PageMethodBinding - Class in ca.uhn.fhir.rest.server.method

PageMethodBinding(FhirContext, Method) - Constructor for class ca.uhn.fhir.rest.server.method.PageMethodBinding

PageProvider - Class in ca.uhn.fhir.rest.server

PageProvider() - Constructor for class ca.uhn.fhir.rest.server.PageProvider

PARAM_RAW - Static variable in class ca.uhn.fhir.rest.server.interceptor.ResponseHighlighterInterceptor

TODO: As of HAPI 1.6 (2016-06-10) this parameter has been replaced with simply requesting _format=json or xml so eventually this parameter should be removed

PARAM_RAW_TRUE - Static variable in class ca.uhn.fhir.rest.server.interceptor.ResponseHighlighterInterceptor

PARAM_TRUE - Static variable in class ca.uhn.fhir.rest.server.interceptor.ResponseHighlighterInterceptor

parse(FhirContext, List<QualifiedParamList>) - Method in class ca.uhn.fhir.rest.server.method.BaseQueryParameter

parse(FhirContext, List<QualifiedParamList>) - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

parseAcceptHeaderAndReturnHighestRankedOptions(HttpServletRequest) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

ParseAction<T> - Class in ca.uhn.fhir.rest.api.server

ParseAction(T) - Constructor for class ca.uhn.fhir.rest.api.server.ParseAction

parsePreferHeader(IRestfulServer<?>, String) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

parseResourceFromRequest(RequestDetails, BaseMethodBinding<?>, Class<? extends IBaseResource>) - Method in interface ca.uhn.fhir.rest.server.IRestfulServerUtil

PARTITION_MANAGEMENT_CREATE_PARTITION - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

Operation name: add partition

PARTITION_MANAGEMENT_DELETE_PARTITION - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

Operation name: update partition

PARTITION_MANAGEMENT_PARTITION_DESC - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

PARTITION_MANAGEMENT_PARTITION_ID - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

PARTITION_MANAGEMENT_PARTITION_NAME - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

PARTITION_MANAGEMENT_READ_PARTITION - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

Operation name: read partition

PARTITION_MANAGEMENT_UPDATE_PARTITION - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

Operation name: update partition

PartitionIdentifyCreate(ServletRequestDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.partition.RequestTenantPartitionInterceptor

PartitionIdentifyRead(ServletRequestDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.partition.RequestTenantPartitionInterceptor

patch() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRule

This rule applies to a FHIR patch operation

PatchMethodBinding - Class in ca.uhn.fhir.rest.server.method

Base class for an operation that has a resource type but not a resource body in the request body

PatchMethodBinding(Method, FhirContext, Object) - Constructor for class ca.uhn.fhir.rest.server.method.PatchMethodBinding

PolicyEnum - Enum in ca.uhn.fhir.rest.server.interceptor.auth

populateActionRequestDetailsForInterceptor(RequestDetails, IServerInterceptor.ActionRequestDetails, Object[]) - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

Subclasses may override this method (but should also call super.BaseMethodBinding.populateActionRequestDetailsForInterceptor(RequestDetails, ActionRequestDetails, Object[]) to provide method specifics to the interceptors.

populateActionRequestDetailsForInterceptor(RequestDetails, IServerInterceptor.ActionRequestDetails, Object[]) - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

populateActionRequestDetailsForInterceptor(RequestDetails, IServerInterceptor.ActionRequestDetails, Object[]) - Method in class ca.uhn.fhir.rest.server.method.TransactionMethodBinding

populateRequestDetailsFromRequestPath(RequestDetails, String) - Method in class ca.uhn.fhir.rest.server.RestfulServer

postProcessResult(RequestDetails, ValidationResult) - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

Hook for subclasses (e.g.

postProcessResultOnFailure(RequestDetails, ValidationResult) - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

Hook for subclasses on failure (e.g.

preferredPageSize() - Method in interface ca.uhn.fhir.rest.api.server.IBundleProvider

Optionally may be used to signal a preferred page size to the server, e.g.

preferredPageSize() - Method in class ca.uhn.fhir.rest.server.SimpleBundleProvider

Defaults to null

preProcessOutgoingException(RequestDetails, Throwable, HttpServletRequest) - Method in class ca.uhn.fhir.rest.server.interceptor.ExceptionHandlingInterceptor

preProcessOutgoingException(RequestDetails, Throwable, HttpServletRequest) - Method in class ca.uhn.fhir.rest.server.interceptor.InterceptorAdapter

preProcessOutgoingException(RequestDetails, Throwable, HttpServletRequest) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerInterceptor

This method is called upon any exception being thrown within the server's request processing code.

preProcessOutgoingResponse(RequestDetails, ResponseDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.FhirPathFilterInterceptor

prettyPrintResponse(IRestfulServerDefaults, RequestDetails) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

PROCEED - ca.uhn.fhir.rest.server.interceptor.consent.ConsentOperationStatusEnum

The requested operation is allowed to proceed, but the engine will review each resource before sending to the client

PROCEED - Static variable in class ca.uhn.fhir.rest.server.interceptor.consent.ConsentOutcome

Convenience constant containing new ConsentOutcome(ConsentOperationStatusEnum.PROCEED)

PROCESSING - Static variable in class ca.uhn.fhir.rest.server.interceptor.ExceptionHandlingInterceptor

processingCompletedNormally(ServletRequestDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.InterceptorAdapter

processingCompletedNormally(ServletRequestDetails) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerInterceptor

This method is called after all processing is completed for a request, but only if the request completes normally (i.e.

processingCompletedNormally(ServletRequestDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.LoggingInterceptor

processLastN(IBaseReference, List<IBaseCoding>, List<IBaseCoding>, IPrimitiveType<Integer>) - Method in class ca.uhn.fhir.rest.server.provider.BaseLastNProvider

Subclasses should implement this method

provideAllowableRequestTypes() - Method in class ca.uhn.fhir.rest.server.method.CreateMethodBinding

provideAllowableRequestTypes() - Method in class ca.uhn.fhir.rest.server.method.DeleteMethodBinding

provideAllowableRequestTypes() - Method in class ca.uhn.fhir.rest.server.method.PatchMethodBinding

provideAllowableRequestTypes() - Method in class ca.uhn.fhir.rest.server.method.UpdateMethodBinding

provideBindings() - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

provider() - Method in class ca.uhn.fhir.rest.server.method.PageMethodBinding

ProviderConstants - Class in ca.uhn.fhir.rest.server.provider

ProviderConstants() - Constructor for class ca.uhn.fhir.rest.server.provider.ProviderConstants

putUserData(String, Object) - Method in class ca.uhn.fhir.rest.api.server.storage.TransactionDetails

Sets an arbitraty object that will last the lifetime of the current transaction

R

RawParamsParameter - Class in ca.uhn.fhir.rest.server.method

RawParamsParameter(List<IParameter>) - Constructor for class ca.uhn.fhir.rest.server.method.RawParamsParameter

read() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRule

This rule applies to any FHIR operation involving reading, including read, vread, search, and history

read(IIdType, RequestDetails) - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

ReadMethodBinding - Class in ca.uhn.fhir.rest.server.method

ReadMethodBinding(Class<? extends IBaseResource>, Method, FhirContext, Object) - Constructor for class ca.uhn.fhir.rest.server.method.ReadMethodBinding

register(Class<? extends IBaseResource>) - Method in class ca.uhn.fhir.rest.server.CommonResourceSupertypeScanner

Recomputes the lowest common superclass by adding a new resource definition to the hierarchy.

registerConsumer(Consumer<ResponseSizeCapturingInterceptor.Result>) - Method in class ca.uhn.fhir.rest.server.interceptor.ResponseSizeCapturingInterceptor

Registers a new consumer.

registerInterceptor(Object) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Registers an interceptor.

registerProvider(Object) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Register a single provider.

registerProviders(Object...) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Register a group of providers.

registerProviders(Collection<?>) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Register a group of theProviders.

registerProviders(Collection<?>, boolean) - Method in class ca.uhn.fhir.rest.server.RestfulServer

REJECT - ca.uhn.fhir.rest.server.interceptor.consent.ConsentOperationStatusEnum

The requested operation cannot proceed, and an operation outcome suitable for the user is available

REJECT - Static variable in class ca.uhn.fhir.rest.server.interceptor.consent.ConsentOutcome

Convenience constant containing new ConsentOutcome(ConsentOperationStatusEnum.REJECT)

removeParameter(String) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

REQUEST_START_TIME - Static variable in class ca.uhn.fhir.rest.server.RestfulServer

All incoming requests will have an attribute added to ServletRequest.getAttribute(String) with this key.

REQUEST_VALIDATION_RESULT - Static variable in class ca.uhn.fhir.rest.server.interceptor.RequestValidatingInterceptor

A user data entry will be created with this key which contains the ValidationResult from validating the request.

RequestDetails - Class in ca.uhn.fhir.rest.api.server

RequestDetails(IInterceptorBroadcaster) - Constructor for class ca.uhn.fhir.rest.api.server.RequestDetails

Constructor

RequestDetailsParameter - Class in ca.uhn.fhir.rest.server.method

RequestDetailsParameter() - Constructor for class ca.uhn.fhir.rest.server.method.RequestDetailsParameter

requestFailed(RequestDetails, BaseServerResponseException) - Method in class ca.uhn.fhir.rest.server.interceptor.consent.ConsentInterceptor

requestSucceeded(RequestDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.consent.ConsentInterceptor

RequestTenantPartitionInterceptor - Class in ca.uhn.fhir.rest.server.interceptor.partition

This interceptor uses the request tenant ID (as supplied to the server using RestfulServer.setTenantIdentificationStrategy(ITenantIdentificationStrategy) to indicate the partition ID.

RequestTenantPartitionInterceptor() - Constructor for class ca.uhn.fhir.rest.server.interceptor.partition.RequestTenantPartitionInterceptor

RequestValidatingInterceptor - Class in ca.uhn.fhir.rest.server.interceptor

This interceptor intercepts each incoming request and if it contains a FHIR resource, validates that resource.

RequestValidatingInterceptor() - Constructor for class ca.uhn.fhir.rest.server.interceptor.RequestValidatingInterceptor

RESOURCE - ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding.MethodReturnTypeEnum

RESOURCE - ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding.ReturnTypeEnum

RESOURCE - ca.uhn.fhir.rest.server.method.ResourceParameter.Mode

RESOURCE_BUNDLE - ca.uhn.fhir.rest.server.method.TransactionParameter.ParamStyle

New style bundle (defined in hapi-fhir-structures-* as a resource definition itself

RESOURCE_LIST - ca.uhn.fhir.rest.server.method.TransactionParameter.ParamStyle

List of resources

ResourceBinding - Class in ca.uhn.fhir.rest.server

Holds all method bindings for an individual resource type

ResourceBinding() - Constructor for class ca.uhn.fhir.rest.server.ResourceBinding

Constructor

ResourceBinding(String, List<BaseMethodBinding<?>>) - Constructor for class ca.uhn.fhir.rest.server.ResourceBinding

Constructor

resourceCreated(RequestDetails, IBaseResource) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerOperationInterceptor

Deprecated.

This method is called by the server immediately after a resource has been created, within the database transaction scope of the operation.

resourceCreated(RequestDetails, IBaseResource) - Method in class ca.uhn.fhir.rest.server.interceptor.ServerOperationInterceptorAdapter

resourceDeleted(RequestDetails, IBaseResource) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerOperationInterceptor

Deprecated.

This method is called by the server immediately after a resource has been deleted, within the database transaction scope of the operation.

resourceDeleted(RequestDetails, IBaseResource) - Method in class ca.uhn.fhir.rest.server.interceptor.ServerOperationInterceptorAdapter

ResourceParameter - Class in ca.uhn.fhir.rest.server.method

ResourceParameter(Class<? extends IBaseResource>, Object, ResourceParameter.Mode, boolean, boolean) - Constructor for class ca.uhn.fhir.rest.server.method.ResourceParameter

ResourceParameter.Mode - Enum in ca.uhn.fhir.rest.server.method

ResourcePersistentId - Class in ca.uhn.fhir.rest.api.server.storage

This class is an abstraction for however primary keys are stored in the underlying storage engine.

ResourcePersistentId(Object) - Constructor for class ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId

resourcePreCreate(RequestDetails, IBaseResource) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerOperationInterceptor

Deprecated.

This method is called by the server immediately before a resource is about to be created, within the database transaction scope of the operation.

resourcePreCreate(RequestDetails, IBaseResource) - Method in class ca.uhn.fhir.rest.server.interceptor.ServerOperationInterceptorAdapter

resourcePreDelete(RequestDetails, IBaseResource) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerOperationInterceptor

Deprecated.

This method is called by the server immediately before a resource is about to be deleted, within the database transaction scope of the operation.

resourcePreDelete(RequestDetails, IBaseResource) - Method in class ca.uhn.fhir.rest.server.interceptor.ServerOperationInterceptorAdapter

resourcePreUpdate(RequestDetails, IBaseResource, IBaseResource) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerOperationInterceptor

Deprecated.

This method is called by the server immediately before a resource is about to be updated, within the database transaction scope of the operation.

resourcePreUpdate(RequestDetails, IBaseResource, IBaseResource) - Method in class ca.uhn.fhir.rest.server.interceptor.ServerOperationInterceptorAdapter

ResourceProviderFactory - Class in ca.uhn.fhir.rest.server.provider

ResourceProviderFactory() - Constructor for class ca.uhn.fhir.rest.server.provider.ResourceProviderFactory

resourcesOfType(Class<? extends IBaseResource>) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderAppliesTo

Rule applies to resources of the given type

resourcesOfType(String) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderAppliesTo

Rule applies to resources of the given type

resourceUpdated(RequestDetails, IBaseResource) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerOperationInterceptor

Deprecated.

Deprecated in HAPI FHIR 3.0.0 in favour of IServerOperationInterceptor.resourceUpdated(RequestDetails, IBaseResource, IBaseResource)

resourceUpdated(RequestDetails, IBaseResource) - Method in class ca.uhn.fhir.rest.server.interceptor.ServerOperationInterceptorAdapter

Deprecated.

Deprecated in HAPI FHIR 2.6 in favour of ServerOperationInterceptorAdapter.resourceUpdated(RequestDetails, IBaseResource, IBaseResource)

resourceUpdated(RequestDetails, IBaseResource, IBaseResource) - Method in interface ca.uhn.fhir.rest.server.interceptor.IServerOperationInterceptor

Deprecated.

This method is called by the server immediately after a resource has been created, within the database transaction scope of the operation.

resourceUpdated(RequestDetails, IBaseResource, IBaseResource) - Method in class ca.uhn.fhir.rest.server.interceptor.ServerOperationInterceptorAdapter

respectPreferHeader(RestOperationTypeEnum) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

RESPONSE_HIGHLIGHTER_INTERCEPTOR - Static variable in class ca.uhn.fhir.rest.server.interceptor.InterceptorOrders

RESPONSE_RESULT_KEY - Static variable in class ca.uhn.fhir.rest.server.interceptor.ResponseSizeCapturingInterceptor

If the response was a character stream, a character count will be placed in the RequestDetails UserData map with this key, containing an ResponseSizeCapturingInterceptor.Result value.

RESPONSE_SIZE_CAPTURING_INTERCEPTOR_COMPLETED - Static variable in class ca.uhn.fhir.rest.server.interceptor.InterceptorOrders

ResponseDetails - Class in ca.uhn.fhir.rest.api.server

ResponseDetails() - Constructor for class ca.uhn.fhir.rest.api.server.ResponseDetails

Constructor

ResponseDetails(IBaseResource) - Constructor for class ca.uhn.fhir.rest.api.server.ResponseDetails

Constructor

ResponseEncoding(FhirContext, EncodingEnum, String) - Constructor for class ca.uhn.fhir.rest.server.RestfulServerUtils.ResponseEncoding

ResponseHighlighterInterceptor - Class in ca.uhn.fhir.rest.server.interceptor

This interceptor detects when a request is coming from a browser, and automatically returns a response with syntax highlighted (coloured) HTML for the response instead of just returning raw XML/JSON.

ResponseHighlighterInterceptor() - Constructor for class ca.uhn.fhir.rest.server.interceptor.ResponseHighlighterInterceptor

Constructor

ResponseSizeCapturingInterceptor - Class in ca.uhn.fhir.rest.server.interceptor

This interceptor captures and makes available the number of characters written (pre-compression if Gzip compression is being used) to the HTTP response stream for FHIR responses.

ResponseSizeCapturingInterceptor() - Constructor for class ca.uhn.fhir.rest.server.interceptor.ResponseSizeCapturingInterceptor

ResponseSizeCapturingInterceptor.Result - Class in ca.uhn.fhir.rest.server.interceptor

Contains the results of the capture

ResponseValidatingInterceptor - Class in ca.uhn.fhir.rest.server.interceptor

This interceptor intercepts each outgoing response and if it contains a FHIR resource, validates that resource.

ResponseValidatingInterceptor() - Constructor for class ca.uhn.fhir.rest.server.interceptor.ResponseValidatingInterceptor

RestfulResponse<T extends RequestDetails> - Class in ca.uhn.fhir.rest.server

RestfulResponse(T) - Constructor for class ca.uhn.fhir.rest.server.RestfulResponse

RestfulServer - Class in ca.uhn.fhir.rest.server

RestfulServer() - Constructor for class ca.uhn.fhir.rest.server.RestfulServer

Constructor.

RestfulServer(FhirContext) - Constructor for class ca.uhn.fhir.rest.server.RestfulServer

Constructor

RestfulServer(FhirContext, IInterceptorService) - Constructor for class ca.uhn.fhir.rest.server.RestfulServer

RestfulServerConfiguration - Class in ca.uhn.fhir.rest.server

RestfulServerConfiguration() - Constructor for class ca.uhn.fhir.rest.server.RestfulServerConfiguration

Constructor

RestfulServerUtils - Class in ca.uhn.fhir.rest.server

RestfulServerUtils() - Constructor for class ca.uhn.fhir.rest.server.RestfulServerUtils

RestfulServerUtils.ResponseEncoding - Class in ca.uhn.fhir.rest.server

Return type for RestfulServerUtils.determineRequestEncodingNoDefault(RequestDetails)

Result(RequestDetails, int) - Constructor for class ca.uhn.fhir.rest.server.interceptor.ResponseSizeCapturingInterceptor.Result

retrieveResultList(RequestDetails, String) - Method in class ca.uhn.fhir.rest.server.FifoMemoryPagingProvider

retrieveResultList(RequestDetails, String) - Method in interface ca.uhn.fhir.rest.server.IPagingProvider

Retrieve a result list by Search ID

retrieveResultList(RequestDetails, String, String) - Method in interface ca.uhn.fhir.rest.server.IPagingProvider

Retrieve a result list by Search ID and Page ID

returnResponse(ParseAction<?>, int, boolean, MethodOutcome, String) - Method in interface ca.uhn.fhir.rest.api.server.IRestfulResponse

This is only used for DSTU1 getTags operations, so it can be removed at some point when we drop DSTU1

returnResponse(ParseAction<?>, int, boolean, MethodOutcome, String) - Method in class ca.uhn.fhir.rest.server.servlet.ServletRestfulResponse

returnResponse(ServletRequestDetails, ParseAction<?>, int, boolean, MethodOutcome, String) - Method in class ca.uhn.fhir.rest.server.RestfulServer

ReturnType() - Constructor for class ca.uhn.fhir.rest.server.method.OperationMethodBinding.ReturnType

RuleBuilder - Class in ca.uhn.fhir.rest.server.interceptor.auth

RuleBuilder() - Constructor for class ca.uhn.fhir.rest.server.interceptor.auth.RuleBuilder

RuleImplConditional - Class in ca.uhn.fhir.rest.server.interceptor.auth

S

searchAll(RequestDetails) - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

searchById(TokenAndListParam, RequestDetails) - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

SearchMethodBinding - Class in ca.uhn.fhir.rest.server.method

SearchMethodBinding(Class<? extends IBaseResource>, Class<? extends IBaseResource>, Method, FhirContext, Object) - Constructor for class ca.uhn.fhir.rest.server.method.SearchMethodBinding

SearchNarrowingInterceptor - Class in ca.uhn.fhir.rest.server.interceptor.auth

This interceptor can be used to automatically narrow the scope of searches in order to automatically restrict the searches to specific compartments.

SearchNarrowingInterceptor() - Constructor for class ca.uhn.fhir.rest.server.interceptor.auth.SearchNarrowingInterceptor

SearchParameter - Class in ca.uhn.fhir.rest.server.method

SearchParameter() - Constructor for class ca.uhn.fhir.rest.server.method.SearchParameter

SearchParameter(String, boolean) - Constructor for class ca.uhn.fhir.rest.server.method.SearchParameter

sendAttachmentResponse(IBaseBinary, int, String) - Method in interface ca.uhn.fhir.rest.api.server.IRestfulResponse

sendAttachmentResponse(IBaseBinary, int, String) - Method in class ca.uhn.fhir.rest.server.servlet.ServletRestfulResponse

sendWriterResponse(int, String, String, Writer) - Method in interface ca.uhn.fhir.rest.api.server.IRestfulResponse

sendWriterResponse(int, String, String, Writer) - Method in class ca.uhn.fhir.rest.server.servlet.ServletRestfulResponse

SERVE_MEDIA_RESOURCE_RAW_INTERCEPTOR - Static variable in class ca.uhn.fhir.rest.server.interceptor.InterceptorOrders

ServeMediaResourceRawInterceptor - Class in ca.uhn.fhir.rest.server.interceptor

This interceptor allows a client to request that a Media resource be served as the raw contents of the resource, assuming either: The client explicitly requests the correct content type using the Accept header The client explicitly requests raw output by adding the parameter _output=data

ServeMediaResourceRawInterceptor() - Constructor for class ca.uhn.fhir.rest.server.interceptor.ServeMediaResourceRawInterceptor

ServerOperationInterceptorAdapter - Class in ca.uhn.fhir.rest.server.interceptor

NOP implementation of IServerOperationInterceptor

ServerOperationInterceptorAdapter() - Constructor for class ca.uhn.fhir.rest.server.interceptor.ServerOperationInterceptorAdapter

service(HttpServletRequest, HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.RestfulServer

SERVLET_CONTEXT_ATTRIBUTE - Static variable in class ca.uhn.fhir.rest.server.RestfulServer

Requests will have an HttpServletRequest attribute set with this name, containing the servlet context, in order to avoid a dependency on Servlet-API 3.0+

ServletRequestDetails - Class in ca.uhn.fhir.rest.server.servlet

ServletRequestDetails(IInterceptorBroadcaster) - Constructor for class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

ServletRequestUtil - Class in ca.uhn.fhir.rest.server.util

ServletRequestUtil() - Constructor for class ca.uhn.fhir.rest.server.util.ServletRequestUtil

ServletRestfulResponse - Class in ca.uhn.fhir.rest.server.servlet

ServletRestfulResponse(ServletRequestDetails) - Constructor for class ca.uhn.fhir.rest.server.servlet.ServletRestfulResponse

Constructor

ServletSubRequestDetails - Class in ca.uhn.fhir.rest.server.servlet

ServletSubRequestDetails(ServletRequestDetails) - Constructor for class ca.uhn.fhir.rest.server.servlet.ServletSubRequestDetails

Constructor

setAddProfileTag(AddProfileTagEnum) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Deprecated.

As of HAPI FHIR 1.5, this property has been moved to FhirContext.setAddProfileTagWhenEncoding(AddProfileTagEnum)

setAddResponseHeaderOnSeverity(ResultSeverityEnum) - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

Sets the minimum severity at which an issue detected by the validator will result in a header being added to the response.

setAddResponseOutcomeHeaderOnSeverity(ResultSeverityEnum) - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

If the validation produces a result with at least the given severity, a header with the name specified by BaseValidatingInterceptor.setResponseOutcomeHeaderName(String) will be added containing a JSON encoded OperationOutcome resource containing the validation results.

setAddValidationResultsToResponseOperationOutcome(boolean) - Method in class ca.uhn.fhir.rest.server.interceptor.RequestValidatingInterceptor

If set to true (default is true), the validation results will be added to the OperationOutcome being returned to the client, unless the response being returned is not an OperationOutcome to begin with (e.g.

setAttribute(String, Object) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

Returns the attribute map for this request.

setAttribute(String, Object) - Method in class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

setBundleInclusionRule(BundleInclusionRule) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Set how bundle factory should decide whether referenced resources should be included in bundles

setCannotBeReused() - Method in interface ca.uhn.fhir.rest.server.util.ICachedSearchDetails

Mark the search as being non-reusable by future queries (as in, the search can serve multiple page requests for pages of the same search, but it won't be reused in the future)

setChainLists(String[], String[]) - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

setCompartmentName(String) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

setCompleteUrl(String) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

setCompositeTypes(Class<? extends IQueryParameterType>[]) - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

setConfig(CorsConfiguration) - Method in class ca.uhn.fhir.rest.server.interceptor.CorsInterceptor

Sets the CORS configuration

setConformanceDate(IPrimitiveType<Date>) - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

Set the date that will be specified in the conformance profile exported by this server.

setConsentService(IConsentService) - Method in class ca.uhn.fhir.rest.server.interceptor.consent.ConsentInterceptor

setContextConsentServices(IConsentContextServices) - Method in class ca.uhn.fhir.rest.server.interceptor.consent.ConsentInterceptor

setConverter(OperationParameter.IOperationParamConverter) - Method in class ca.uhn.fhir.rest.server.method.OperationParameter

setCurrentPageId(String) - Method in class ca.uhn.fhir.rest.server.BundleProviderWithNamedPages

setDeclaredTypes(Class<? extends IBaseResource>[]) - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

setDefaultPageSize(int) - Method in class ca.uhn.fhir.rest.server.BasePagingProvider

setDefaultPolicy(PolicyEnum) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

The default policy if no rules have been found to apply.

setDefaultPreferReturn(PreferReturnEnum) - Method in class ca.uhn.fhir.rest.server.RestfulServer

By default, server create/update/patch/transaction methods return a copy of the resource as it was stored.

setDefaultPrettyPrint(boolean) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Should the server "pretty print" responses by default (requesting clients can always override this default by supplying an Accept header in the request, or a _pretty parameter in the request URL.

setDefaultResponseEncoding(EncodingEnum) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Sets the default encoding to return (XML/JSON) if an incoming request does not specify a preference (either with the _format URL parameter, or with an Accept header in the request.

setDescription(String) - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

setDescription(String) - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

setDontReturnResourceAtIndex(int) - Method in interface ca.uhn.fhir.rest.api.server.IPreResourceAccessDetails

setDontReturnResourceAtIndex(int) - Method in class ca.uhn.fhir.rest.api.server.SimplePreResourceAccessDetails

setElementsSupport(ElementsSupportEnum) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Sets the elements support mode.

setErrorMessageFormat(String) - Method in class ca.uhn.fhir.rest.server.interceptor.LoggingInterceptor

Set the log message format to be used when logging exceptions

setETagSupport(ETagSupportEnum) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Sets (enables/disables) the server support for ETags.

setFailOnSeverity(ResultSeverityEnum) - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

Sets the minimum severity at which an issue detected by the validator will fail/reject the request.

setFhirContext(FhirContext) - Method in class ca.uhn.fhir.rest.server.RestfulServer

setFhirContext(FhirContext) - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

Set the fhirContext

setFhirServerBase(String) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

setFixedConditionalUrl(String) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

setFlags(AuthorizationFlagsEnum...) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

This property configures any flags affecting how authorization is applied.

setFlags(Collection<AuthorizationFlagsEnum>) - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor

This property configures any flags affecting how authorization is applied.

setHeaderName(String) - Method in class ca.uhn.fhir.rest.server.interceptor.CaptureResourceSourceFromHeaderInterceptor

Provides the header name to examine in incoming requests.

setId(Object) - Method in class ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId

setId(IIdType) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

setIgnoreServerParsedRequestParameters(boolean) - Method in class ca.uhn.fhir.rest.server.RestfulServer

If set to true (the default is true) this server will not use the parsed request parameters (URL parameters and HTTP POST form contents) but will instead parse these values manually from the request URL and request body.

setIgnoreValidatorExceptions(boolean) - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

If set to true (default is false) this interceptor will exit immediately and allow processing to continue if the validator throws any exceptions.

setImplementationDescription(String) - Method in class ca.uhn.fhir.rest.server.RestfulServer

setImplementationDescription(String) - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

Set the implementationDescription

setInterceptors(IServerInterceptor...) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Deprecated.

As of HAPI FHIR 3.8.0, use RestfulServer.getInterceptorService() to access the interceptor service. You can register and unregister interceptors using this service.

setInterceptors(List<?>) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Deprecated.

As of HAPI FHIR 3.8.0, use RestfulServer.getInterceptorService() to access the interceptor service. You can register and unregister interceptors using this service.

setInterceptorService(IInterceptorService) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Sets the interceptor registry for this service.

setLogExceptions(boolean) - Method in class ca.uhn.fhir.rest.server.interceptor.LoggingInterceptor

Should exceptions be logged by this logger

setLogger(Logger) - Method in class ca.uhn.fhir.rest.server.interceptor.LoggingInterceptor

setLoggerName(String) - Method in class ca.uhn.fhir.rest.server.interceptor.LoggingInterceptor

setMax(int) - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding.ReturnType

setMaximumHeaderLength(int) - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

The maximum length for an individual header.

setMaximumPageSize(int) - Method in class ca.uhn.fhir.rest.server.BasePagingProvider

setMessageFormat(String) - Method in class ca.uhn.fhir.rest.server.interceptor.LoggingInterceptor

Sets the message format itself.

setMethods(List<BaseMethodBinding<?>>) - Method in class ca.uhn.fhir.rest.server.ResourceBinding

setMin(int) - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding.ReturnType

setName(String) - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding.ReturnType

setName(String) - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

setNameToSharedSupertype(Map<String, Class<? extends IBaseResource>>) - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

setNextPageId(String) - Method in class ca.uhn.fhir.rest.server.BundleProviderWithNamedPages

setOperation(String) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

setOperationResourceId(IIdType) - Method in interface ca.uhn.fhir.rest.api.server.IRestfulResponse

setOperationResourceId(IIdType) - Method in class ca.uhn.fhir.rest.server.RestfulResponse

setOperationResourceLastUpdated(IPrimitiveType<Date>) - Method in interface ca.uhn.fhir.rest.api.server.IRestfulResponse

setOperationResourceLastUpdated(IPrimitiveType<Date>) - Method in class ca.uhn.fhir.rest.server.RestfulResponse

setPagingProvider(IPagingProvider) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Sets the paging provider to use, or null to use no paging (which is the default)

setParameters(List<IParameter>) - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

For unit tests only

setParameters(Map<String, String[]>) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

setPlainProviders(Object...) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Deprecated.

This method causes inconsistent behaviour depending on the order it is called in. Use RestfulServer.registerProviders(Object...) instead.

setPlainProviders(Collection<Object>) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Deprecated.

This method causes inconsistent behaviour depending on the order it is called in. Use RestfulServer.registerProviders(Object...) instead.

setPreferredPageSize(Integer) - Method in class ca.uhn.fhir.rest.server.SimpleBundleProvider

Sets the preferred page size to be returned by SimpleBundleProvider.preferredPageSize().

setPreviousPageId(String) - Method in class ca.uhn.fhir.rest.server.BundleProviderWithNamedPages

setProviders(Object...) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Sets the non-resource specific providers which implement method calls on this server

setPublished(IPrimitiveType<Date>) - Method in class ca.uhn.fhir.rest.server.SimpleBundleProvider

By default this class uses the object creation date/time (for this object) to determine the published date but this method may be used to specify an alternate date/time

setRequestContents(byte[]) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

This method may be used to modify the contents of the incoming request by hardcoding a value which will be used instead of the value received by the client.

setRequestDetails(T) - Method in class ca.uhn.fhir.rest.server.RestfulResponse

Set the requestDetails

setRequestId(String) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

setRequestPath(String) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

setRequestType(RequestTypeEnum) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

setRequired(boolean) - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

setResource(int, IBaseResource) - Method in interface ca.uhn.fhir.rest.api.server.IPreResourceShowDetails

Replace the resource being returned at index

setResource(int, IBaseResource) - Method in class ca.uhn.fhir.rest.api.server.SimplePreResourceShowDetails

setResource(IBaseResource) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

Sets the request resource (as provided in the request body) if it has been parsed.

setResource(IBaseResource) - Method in class ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails

Deprecated.

This method should not be called by client code

setResourceBindings(Collection<ResourceBinding>) - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

Set the resourceBindings

setResourceName(String) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

setResourceName(String) - Method in class ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding

setResourceName(String) - Method in class ca.uhn.fhir.rest.server.ResourceBinding

setResourceProviders(IResourceProvider...) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Sets the resource providers for this server

setResourceProviders(Collection<IResourceProvider>) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Sets the resource providers for this server

setRespondGzip(boolean) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

setResponse(IRestfulResponse) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

setResponseCode(int) - Method in class ca.uhn.fhir.rest.api.server.ResponseDetails

setResponseHeaderName(String) - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

Sets the name of the response header to add validation failures to

setResponseHeaderName(String) - Method in class ca.uhn.fhir.rest.server.interceptor.RequestValidatingInterceptor

Sets the name of the response header to add validation failures to

setResponseHeaderName(String) - Method in class ca.uhn.fhir.rest.server.interceptor.ResponseValidatingInterceptor

Sets the name of the response header to add validation failures to

setResponseHeaderValue(String) - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

Sets the value to add to the response header with the name specified by BaseValidatingInterceptor.setResponseHeaderName(String) when validation produces a message of severity equal to or greater than BaseValidatingInterceptor.setAddResponseHeaderOnSeverity(ResultSeverityEnum)

setResponseHeaderValueNoIssues(String) - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

Sets the header value to add when no issues are found at or exceeding the threshold specified by BaseValidatingInterceptor.setAddResponseHeaderOnSeverity(ResultSeverityEnum)

setResponseOutcomeHeaderName(String) - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

The name of the header specified by BaseValidatingInterceptor.setAddResponseOutcomeHeaderOnSeverity(ResultSeverityEnum)

setResponseResource(IBaseResource) - Method in class ca.uhn.fhir.rest.api.server.ResponseDetails

Set the resource which will be returned to the client

setRestfulServer(RestfulServer) - Method in interface ca.uhn.fhir.rest.server.IServerConformanceProvider

This setter is needed in implementation classes (along with a no-arg constructor) to avoid reference cycles in the Spring wiring of a RestfulServer instance.

setRestOperationType(RestOperationTypeEnum) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

setReturnStackTracesForExceptionTypes(Class<?>...) - Method in class ca.uhn.fhir.rest.server.interceptor.ExceptionHandlingInterceptor

If any server methods throw an exception which extends any of the given exception types, the exception stack trace will be returned to the user.

setSecondaryOperation(String) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

setServer(RestfulServer) - Method in class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

setServerAddressStrategy(IServerAddressStrategy) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Provide a server address strategy, which is used to determine what base URL to provide clients to refer to this server.

setServerAddressStrategy(IServerAddressStrategy) - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

Set the serverAddressStrategy

setServerBindings(List<BaseMethodBinding<?>>) - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

Set the theServerBindings

setServerConformanceProvider(Object) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Returns the server conformance provider, which is the provider that is used to generate the server's conformance (metadata) statement.

setServerName(String) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Sets the server's name, as exported in conformance profiles exported by the server.

setServerName(String) - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

Set the serverName

setServerVersion(String) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Gets the server's version, as exported in conformance profiles exported by the server.

setServerVersion(String) - Method in class ca.uhn.fhir.rest.server.RestfulServerConfiguration

Set the serverVersion

setServletPath(String) - Method in class ca.uhn.fhir.rest.server.IncomingRequestAddressStrategy

If set to a non-null value (default is null), this address strategy assumes that the FHIR endpoint is deployed to the given servlet path within the context.

setServletRequest(HttpServletRequest) - Method in class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

setServletResponse(HttpServletResponse) - Method in class ca.uhn.fhir.rest.server.servlet.ServletRequestDetails

setShowRequestHeaders(boolean) - Method in class ca.uhn.fhir.rest.server.interceptor.ResponseHighlighterInterceptor

If set to true (default is false) response will include the request headers

setShowResponseHeaders(boolean) - Method in class ca.uhn.fhir.rest.server.interceptor.ResponseHighlighterInterceptor

If set to true (default is true) response will include the response headers

setSize(Integer) - Method in class ca.uhn.fhir.rest.server.BundleProviderWithNamedPages

setSize(Integer) - Method in class ca.uhn.fhir.rest.server.SimpleBundleProvider

Sets the total number of results, if this provider corresponds to a single page within a larger search result

setSubRequest(boolean) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

Is this request a sub-request (i.e.

setTarget(IConsentService) - Method in class ca.uhn.fhir.rest.server.interceptor.consent.DelegatingConsentService

setTenantId(String) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

setTenantIdentificationStrategy(ITenantIdentificationStrategy) - Method in class ca.uhn.fhir.rest.server.RestfulServer

If provided (default is null), the tenant identification strategy provides a mechanism for a multitenant server to identify which tenant a given request corresponds to.

setTransactionGuid(String) - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

setType(FhirContext, Class<?>, Class<? extends Collection<?>>, Class<? extends Collection<?>>) - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

setType(String) - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding.ReturnType

setUncompressIncomingContents(boolean) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Should the server attempt to decompress incoming request contents (default is true).

setValidatorModules(List<IValidatorModule>) - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

setValue(String) - Method in class ca.uhn.fhir.rest.server.HardcodedServerAddressStrategy

SimpleBundleProvider - Class in ca.uhn.fhir.rest.server

SimpleBundleProvider() - Constructor for class ca.uhn.fhir.rest.server.SimpleBundleProvider

Create an empty bundle

SimpleBundleProvider(List<? extends IBaseResource>) - Constructor for class ca.uhn.fhir.rest.server.SimpleBundleProvider

Constructor

SimpleBundleProvider(List<? extends IBaseResource>, String) - Constructor for class ca.uhn.fhir.rest.server.SimpleBundleProvider

SimpleBundleProvider(IBaseResource) - Constructor for class ca.uhn.fhir.rest.server.SimpleBundleProvider

Constructor

SimplePreResourceAccessDetails - Class in ca.uhn.fhir.rest.api.server

SimplePreResourceAccessDetails(List<T>) - Constructor for class ca.uhn.fhir.rest.api.server.SimplePreResourceAccessDetails

SimplePreResourceAccessDetails(IBaseResource) - Constructor for class ca.uhn.fhir.rest.api.server.SimplePreResourceAccessDetails

SimplePreResourceShowDetails - Class in ca.uhn.fhir.rest.api.server

SimplePreResourceShowDetails(Collection<T>) - Constructor for class ca.uhn.fhir.rest.api.server.SimplePreResourceShowDetails

Constructor for a collection of resources

SimplePreResourceShowDetails(IBaseResource) - Constructor for class ca.uhn.fhir.rest.api.server.SimplePreResourceShowDetails

Constructor for a single resource

size() - Method in interface ca.uhn.fhir.rest.api.server.IBundleProvider

Returns the total number of results which match the given query (exclusive of any _include's or OperationOutcome).

size() - Method in interface ca.uhn.fhir.rest.api.server.IPreResourceAccessDetails

size() - Method in interface ca.uhn.fhir.rest.api.server.IPreResourceShowDetails

size() - Method in class ca.uhn.fhir.rest.api.server.SimplePreResourceAccessDetails

size() - Method in class ca.uhn.fhir.rest.api.server.SimplePreResourceShowDetails

size() - Method in class ca.uhn.fhir.rest.server.SimpleBundleProvider

sizeOrThrowNpe() - Method in interface ca.uhn.fhir.rest.api.server.IBundleProvider

Returns the value of IBundleProvider.size() and throws a NullPointerException of it is null

SortParameter - Class in ca.uhn.fhir.rest.server.method

SortParameter(FhirContext) - Constructor for class ca.uhn.fhir.rest.server.method.SortParameter

STANDARD - ca.uhn.fhir.rest.server.ElementsSupportEnum

The server will support only the FHIR standard features for the _elements parameter.

startDeferredOperationCallback() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

Sets the RequestDetails.getInterceptorBroadcaster() () interceptor broadcaster} handler in deferred mode, meaning that any notifications will be queued up for delivery, but won't be delivered until RequestDetails.stopDeferredRequestOperationCallbackAndRunDeferredItems() is called.

startOperation(RequestDetails, IConsentContextServices) - Method in class ca.uhn.fhir.rest.server.interceptor.consent.DelegatingConsentService

startOperation(RequestDetails, IConsentContextServices) - Method in interface ca.uhn.fhir.rest.server.interceptor.consent.IConsentService

This method is called when an operation is initially beginning, before any significant processing occurs.

stopDeferredRequestOperationCallbackAndRunDeferredItems() - Method in class ca.uhn.fhir.rest.api.server.RequestDetails

store(T) - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

This is a utility method that can be used to store a resource without having to use the outside API.

storeResultList(RequestDetails, IBundleProvider) - Method in class ca.uhn.fhir.rest.server.FifoMemoryPagingProvider

storeResultList(RequestDetails, IBundleProvider) - Method in interface ca.uhn.fhir.rest.server.IPagingProvider

Stores a result list and returns an ID with which that list can be returned

streamResponseAsResource(IRestfulServerDefaults, IBaseResource, Set<SummaryEnum>, int, boolean, boolean, RequestDetails) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

streamResponseAsResource(IRestfulServerDefaults, IBaseResource, Set<SummaryEnum>, int, String, boolean, boolean, RequestDetails, IIdType, IPrimitiveType<Date>) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

streamResponseAsResource(IBaseResource, boolean, Set<SummaryEnum>, int, String, boolean, boolean) - Method in interface ca.uhn.fhir.rest.api.server.IRestfulResponse

streamResponseAsResource(IBaseResource, boolean, Set<SummaryEnum>, int, String, boolean, boolean) - Method in class ca.uhn.fhir.rest.server.RestfulResponse

SUBSCRIPTION_TRIGGERING_PARAM_RESOURCE_ID - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

SUBSCRIPTION_TRIGGERING_PARAM_SEARCH_URL - Static variable in class ca.uhn.fhir.rest.server.provider.ProviderConstants

SummaryEnumParameter - Class in ca.uhn.fhir.rest.server.method

SummaryEnumParameter() - Constructor for class ca.uhn.fhir.rest.server.method.SummaryEnumParameter

supportsRepetition() - Method in class ca.uhn.fhir.rest.server.method.BaseQueryParameter

supportsRepetition() - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

T

theOutcome - Variable in class ca.uhn.fhir.rest.api.server.ParseAction

throwInvalidMode(String) - Static method in class ca.uhn.fhir.rest.server.method.OperationParameter

throwUnknownFhirOperationException(RequestDetails, String, RequestTypeEnum) - Method in class ca.uhn.fhir.rest.server.RestfulServer

throwUnknownFhirOperationException(RequestDetails, String, RequestTypeEnum, FhirContext) - Static method in class ca.uhn.fhir.rest.server.RestfulServer

throwUnknownResourceTypeException(String) - Method in class ca.uhn.fhir.rest.server.RestfulServer

toList() - Method in class ca.uhn.fhir.rest.api.server.SimplePreResourceShowDetails

toLongList(Collection<ResourcePersistentId>) - Static method in class ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId

toResourceList(Object) - Method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

toString() - Method in class ca.uhn.fhir.rest.api.server.storage.ResourcePersistentId

toString() - Method in class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor.Verdict

toString() - Method in class ca.uhn.fhir.rest.server.interceptor.IServerInterceptor.ActionRequestDetails

Deprecated.

toString() - Method in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

toString() - Method in class ca.uhn.fhir.rest.server.method.SearchMethodBinding

toString() - Method in class ca.uhn.fhir.rest.server.method.SearchParameter

transaction() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRule

This rule applies to the FHIR transaction operation.

TransactionDetails - Class in ca.uhn.fhir.rest.api.server.storage

This object contains runtime information that is gathered and relevant to a single database transaction.

TransactionDetails() - Constructor for class ca.uhn.fhir.rest.api.server.storage.TransactionDetails

Constructor

TransactionDetails(Date) - Constructor for class ca.uhn.fhir.rest.api.server.storage.TransactionDetails

Constructor

TransactionMethodBinding - Class in ca.uhn.fhir.rest.server.method

TransactionMethodBinding(Method, FhirContext, Object) - Constructor for class ca.uhn.fhir.rest.server.method.TransactionMethodBinding

TransactionParameter - Class in ca.uhn.fhir.rest.server.method

TransactionParameter.ParamStyle - Enum in ca.uhn.fhir.rest.server.method

translateQueryParametersIntoServerArgument(RequestDetails, BaseMethodBinding<?>) - Method in class ca.uhn.fhir.rest.server.method.BaseQueryParameter

translateQueryParametersIntoServerArgument(RequestDetails, BaseMethodBinding<?>) - Method in class ca.uhn.fhir.rest.server.method.CountParameter

translateQueryParametersIntoServerArgument(RequestDetails, BaseMethodBinding<?>) - Method in class ca.uhn.fhir.rest.server.method.ElementsParameter

translateQueryParametersIntoServerArgument(RequestDetails, BaseMethodBinding<?>) - Method in class ca.uhn.fhir.rest.server.method.GraphQLQueryParameter

translateQueryParametersIntoServerArgument(RequestDetails, BaseMethodBinding<?>) - Method in interface ca.uhn.fhir.rest.server.method.IParameter

This server method method takes the data received by the server in an incoming request, and translates that data into a single argument for a server method invocation.

translateQueryParametersIntoServerArgument(RequestDetails, BaseMethodBinding<?>) - Method in class ca.uhn.fhir.rest.server.method.OperationParameter

translateQueryParametersIntoServerArgument(RequestDetails, BaseMethodBinding<?>) - Method in class ca.uhn.fhir.rest.server.method.RawParamsParameter

translateQueryParametersIntoServerArgument(RequestDetails, BaseMethodBinding<?>) - Method in class ca.uhn.fhir.rest.server.method.RequestDetailsParameter

translateQueryParametersIntoServerArgument(RequestDetails, BaseMethodBinding<?>) - Method in class ca.uhn.fhir.rest.server.method.ResourceParameter

translateQueryParametersIntoServerArgument(RequestDetails, BaseMethodBinding<?>) - Method in class ca.uhn.fhir.rest.server.method.SortParameter

translateQueryParametersIntoServerArgument(RequestDetails, BaseMethodBinding<?>) - Method in class ca.uhn.fhir.rest.server.method.SummaryEnumParameter

translateQueryParametersIntoServerArgument(RequestDetails, BaseMethodBinding<?>) - Method in class ca.uhn.fhir.rest.server.method.TransactionParameter

tryToExtractNamedParameter(RequestDetails, String) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

U

unregisterAllProviders() - Method in class ca.uhn.fhir.rest.server.RestfulServer

Unregisters all plain and resource providers (but not the conformance provider).

unregisterInterceptor(Object) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Unregisters an interceptor.

unregisterProvider(Object) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Unregister one provider (either a Resource provider or a plain provider)

unregisterProviders(Collection<?>) - Method in class ca.uhn.fhir.rest.server.RestfulServer

Unregister a Collection of providers

update(Supplier<Object>) - Method in interface ca.uhn.fhir.rest.server.provider.IResourceProviderFactoryObserver

update(T, String, RequestDetails) - Method in class ca.uhn.fhir.rest.server.provider.HashMapResourceProvider

updateConditional() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRule

This rule applies to update operations with a conditional URL as a part of the request.

UpdateMethodBinding - Class in ca.uhn.fhir.rest.server.method

UpdateMethodBinding(Method, FhirContext, Object) - Constructor for class ca.uhn.fhir.rest.server.method.UpdateMethodBinding

UrlBaseTenantIdentificationStrategy - Class in ca.uhn.fhir.rest.server.tenant

This class is a tenant identification strategy which assumes that a single path element will be present between the server base URL and individual request.

UrlBaseTenantIdentificationStrategy() - Constructor for class ca.uhn.fhir.rest.server.tenant.UrlBaseTenantIdentificationStrategy

V

validate(T, RequestDetails) - Method in class ca.uhn.fhir.rest.server.interceptor.BaseValidatingInterceptor

Note: May return null

ValidateMethodBindingDstu2Plus - Class in ca.uhn.fhir.rest.server.method

ValidateMethodBindingDstu2Plus(Class<?>, Class<? extends IBaseResource>, Method, FhirContext, Object, Validate) - Constructor for class ca.uhn.fhir.rest.server.method.ValidateMethodBindingDstu2Plus

validateRequest(ServletRequestDetails) - Method in class ca.uhn.fhir.rest.server.RestfulServer

validateResourceIdAndUrlIdForNonConditionalOperation(IBaseResource, String, String, String) - Method in class ca.uhn.fhir.rest.server.method.CreateMethodBinding

validateResourceIdAndUrlIdForNonConditionalOperation(IBaseResource, String, String, String) - Method in class ca.uhn.fhir.rest.server.method.UpdateMethodBinding

validateResourceListNotNull(List<? extends IBaseResource>) - Static method in class ca.uhn.fhir.rest.server.RestfulServerUtils

valueOf(String) - Static method in enum ca.uhn.fhir.rest.server.ElementsSupportEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ca.uhn.fhir.rest.server.ETagSupportEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationFlagsEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ca.uhn.fhir.rest.server.interceptor.auth.PolicyEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ca.uhn.fhir.rest.server.interceptor.consent.ConsentOperationStatusEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding.MethodReturnTypeEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding.ReturnTypeEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ca.uhn.fhir.rest.server.method.MethodMatchEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ca.uhn.fhir.rest.server.method.ResourceParameter.Mode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum ca.uhn.fhir.rest.server.method.TransactionParameter.ParamStyle

Returns the enum constant of this type with the specified name.

values() - Static method in enum ca.uhn.fhir.rest.server.ElementsSupportEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ca.uhn.fhir.rest.server.ETagSupportEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationFlagsEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ca.uhn.fhir.rest.server.interceptor.auth.PolicyEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ca.uhn.fhir.rest.server.interceptor.consent.ConsentOperationStatusEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding.MethodReturnTypeEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding.ReturnTypeEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ca.uhn.fhir.rest.server.method.MethodMatchEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ca.uhn.fhir.rest.server.method.ResourceParameter.Mode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum ca.uhn.fhir.rest.server.method.TransactionParameter.ParamStyle

Returns an array containing the constants of this enum type, in the order they are declared.

VerboseLoggingInterceptor - Class in ca.uhn.fhir.rest.server.interceptor

This interceptor creates verbose server log entries containing the complete request and response payloads.

VerboseLoggingInterceptor() - Constructor for class ca.uhn.fhir.rest.server.interceptor.VerboseLoggingInterceptor

Verdict(PolicyEnum, IAuthRule) - Constructor for class ca.uhn.fhir.rest.server.interceptor.auth.AuthorizationInterceptor.Verdict

verifyMethodHasZeroOrOneOperationAnnotation(Method, Object...) - Static method in class ca.uhn.fhir.rest.server.method.BaseMethodBinding

VOID - ca.uhn.fhir.rest.server.method.BaseResourceReturningMethodBinding.MethodReturnTypeEnum

W

weakerOf(MethodMatchEnum) - Method in enum ca.uhn.fhir.rest.server.method.MethodMatchEnum

WILDCARD_NAME - Static variable in class ca.uhn.fhir.rest.server.method.OperationMethodBinding

willSeeResource(RequestDetails, IBaseResource, IConsentContextServices) - Method in class ca.uhn.fhir.rest.server.interceptor.consent.DelegatingConsentService

willSeeResource(RequestDetails, IBaseResource, IConsentContextServices) - Method in interface ca.uhn.fhir.rest.server.interceptor.consent.IConsentService

This method is called if a user is about to see a resource, either completely or partially.

withAnyId() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRuleOpClassifier

Rule applies to any resource instances

withAnyName() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderOperation

This rule applies to any operation

withAnyOperation() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRuleTransaction

This rules applies to transactions with any operation nested in them.

withTester(IAuthRuleTester) - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleFinished

Add an additional tester that will be queried if all other conditions of this rule already match.

write() - Method in interface ca.uhn.fhir.rest.server.interceptor.auth.IAuthRuleBuilderRule

This rule applies to any FHIR operation involving writing, including create, and update

A B C D E F G H I L M N O P R S T U V W
All Classes All Packages