Package ca.uhn.fhir.jpa.dao

Class BaseStorageDao

java.lang.Object

ca.uhn.fhir.jpa.dao.BaseStorageDao

Direct Known Subclasses:

BaseStorageResourceDao

public abstract class BaseStorageDao
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	MESSAGE_KEY_DELETE_RESOURCE_ALREADY_DELETED
protected static final String	MESSAGE_KEY_DELETE_RESOURCE_NOT_EXISTING
protected DaoRegistry	myDaoRegistry
protected ca.uhn.fhir.context.FhirContext	myFhirContext
protected IMetaTagSorter	myMetaTagSorter
protected IResourceVersionSvc	myResourceVersionSvc
protected ca.uhn.fhir.rest.server.util.ISearchParamRegistry	mySearchParamRegistry
protected JpaStorageSettings	myStorageSettings
static final String	OO_ISSUE_CODE_INFORMATIONAL
static final String	OO_SEVERITY_ERROR	Deprecated, for removal: This API element is subject to removal in a future version. moved to OperationOutcomeUtil.OO_SEVERITY_ERROR
static final String	OO_SEVERITY_INFO	Deprecated, for removal: This API element is subject to removal in a future version. moved to OperationOutcomeUtil.OO_SEVERITY_INFO
static final String	OO_SEVERITY_WARN	Deprecated, for removal: This API element is subject to removal in a future version. moved to OperationOutcomeUtil.OO_SEVERITY_WARN

Constructor Summary

Constructors

Constructor	Description
BaseStorageDao()

Method Summary

Modifier and Type	Method	Description
static String	addIssueToOperationOutcomeForAutoCreatedPlaceholder(ca.uhn.fhir.context.FhirContext theFhirContext, org.hl7.fhir.instance.model.api.IIdType thePlaceholderId, org.hl7.fhir.instance.model.api.IBaseOperationOutcome theOperationOutcomeToPopulate)
static void	clearRequestAsProcessingSubRequest(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)
org.hl7.fhir.instance.model.api.IBaseOperationOutcome	createErrorOperationOutcome(String theMessage, String theCode)
org.hl7.fhir.instance.model.api.IBaseOperationOutcome	createInfoOperationOutcome(String theMessage)
org.hl7.fhir.instance.model.api.IBaseOperationOutcome	createInfoOperationOutcome(String theMessage, ca.uhn.fhir.model.api.StorageResponseCodeEnum theStorageResponseCode)
protected DaoMethodOutcome	createMethodOutcomeForResourceId(String theResourceId, String theMessageKey, ca.uhn.fhir.model.api.StorageResponseCodeEnum theStorageResponseCode)	Creates a base method outcome for a delete request for the provided ID.
protected ca.uhn.fhir.rest.server.exceptions.ResourceGoneException	createResourceGoneException(IBasePersistedResource theResourceEntity)
org.hl7.fhir.instance.model.api.IBaseOperationOutcome	createWarnOperationOutcome(String theMsg, String theCode, ca.uhn.fhir.model.api.StorageResponseCodeEnum theResponseCodeEnum)
protected void	doCallHooks(ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails, ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails, ca.uhn.fhir.interceptor.api.Pointcut thePointcut, ca.uhn.fhir.interceptor.api.HookParams theParams)
static Set<org.hl7.fhir.instance.model.api.IBaseReference>	extractReferencesToAutoVersion(ca.uhn.fhir.context.FhirContext theFhirContext, StorageSettings theStorageSettings, org.hl7.fhir.instance.model.api.IBaseResource theResource)	Extracts a list of references that should be auto-versioned.
static Set<org.hl7.fhir.instance.model.api.IBaseReference>	extractReferencesToAvoidReplacement(ca.uhn.fhir.context.FhirContext theFhirContext, org.hl7.fhir.instance.model.api.IBaseResource theResource)	Extracts a list of references that have versions in their ID whose versions should not be stripped
protected abstract ca.uhn.fhir.context.FhirContext	getContext()	Provides the FHIR context
protected abstract ca.uhn.fhir.interceptor.api.IInterceptorBroadcaster	getInterceptorBroadcaster()
protected abstract String	getResourceName()	Returns the resource type for this DAO, or null if this is a system-level DAO
protected abstract JpaStorageSettings	getStorageSettings()	Provide the JpaStorageSettings
static void	markRequestAsProcessingSubRequest(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)
protected void	populateOperationOutcomeForUpdate(ca.uhn.fhir.util.StopWatch theItemStopwatch, DaoMethodOutcome theMethodOutcome, String theMatchUrl, ca.uhn.fhir.rest.api.RestOperationTypeEnum theOperationType, ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails)
protected void	preProcessResourceForStorage(org.hl7.fhir.instance.model.api.IBaseResource theResource)	Deprecated. Use preProcessResourceForStorage(IBaseResource, RequestDetails, TransactionDetails, boolean) instead
protected void	preProcessResourceForStorage(org.hl7.fhir.instance.model.api.IBaseResource theResource, ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails, ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails, boolean thePerformIndexing)	May be overridden by subclasses to validate resources prior to storage
void	setMyMetaTagSorter(IMetaTagSorter theMetaTagSorter)
void	setSearchParamRegistry(ca.uhn.fhir.rest.server.util.ISearchParamRegistry theSearchParamRegistry)
protected DaoMethodOutcome	toMethodOutcome(ca.uhn.fhir.rest.api.server.RequestDetails theRequest, IBasePersistedResource theEntity, org.hl7.fhir.instance.model.api.IBaseResource theResource, String theMatchUrl, ca.uhn.fhir.rest.api.RestOperationTypeEnum theOperationType)
protected DaoMethodOutcome	toMethodOutcomeLazy(ca.uhn.fhir.rest.api.server.RequestDetails theRequest, ca.uhn.fhir.rest.api.server.storage.IResourcePersistentId theResourcePersistentId, Supplier<LazyDaoMethodOutcome.EntityAndResource> theEntity, Supplier<org.hl7.fhir.instance.model.api.IIdType> theIdSupplier)
void	translateRawParameters(Map<String,List<String>> theSource, SearchParameterMap theTarget)
protected void	verifyResourceIdIsValid(org.hl7.fhir.instance.model.api.IBaseResource theResource)	Verify that the resource ID is actually valid according to FHIR's rules

Methods inherited from class java.lang.Object

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

Field Details

OO_SEVERITY_ERROR

@Deprecated(forRemoval=true,
            since="8.4.0")
public static final String OO_SEVERITY_ERROR

Deprecated, for removal: This API element is subject to removal in a future version.

moved to OperationOutcomeUtil.OO_SEVERITY_ERROR

See Also:

• Constant Field Values

OO_SEVERITY_INFO

@Deprecated(forRemoval=true,
            since="8.4.0")
public static final String OO_SEVERITY_INFO

Deprecated, for removal: This API element is subject to removal in a future version.

moved to OperationOutcomeUtil.OO_SEVERITY_INFO

See Also:

• Constant Field Values

OO_SEVERITY_WARN

@Deprecated(forRemoval=true,
            since="8.4.0")
public static final String OO_SEVERITY_WARN

Deprecated, for removal: This API element is subject to removal in a future version.

moved to OperationOutcomeUtil.OO_SEVERITY_WARN

See Also:

• Constant Field Values

MESSAGE_KEY_DELETE_RESOURCE_NOT_EXISTING

protected static final String MESSAGE_KEY_DELETE_RESOURCE_NOT_EXISTING

See Also:

• Constant Field Values

MESSAGE_KEY_DELETE_RESOURCE_ALREADY_DELETED

protected static final String MESSAGE_KEY_DELETE_RESOURCE_ALREADY_DELETED

See Also:

• Constant Field Values

OO_ISSUE_CODE_INFORMATIONAL

public static final String OO_ISSUE_CODE_INFORMATIONAL

See Also:

• Constant Field Values

mySearchParamRegistry

@Autowired
protected ca.uhn.fhir.rest.server.util.ISearchParamRegistry mySearchParamRegistry

myFhirContext

@Autowired
protected ca.uhn.fhir.context.FhirContext myFhirContext

myDaoRegistry

@Autowired
protected DaoRegistry myDaoRegistry

myResourceVersionSvc

@Autowired
protected IResourceVersionSvc myResourceVersionSvc

myStorageSettings

@Autowired
protected JpaStorageSettings myStorageSettings

myMetaTagSorter

@Autowired
protected IMetaTagSorter myMetaTagSorter

Constructor Details

BaseStorageDao

public BaseStorageDao()

Method Details

setSearchParamRegistry

public void setSearchParamRegistry(ca.uhn.fhir.rest.server.util.ISearchParamRegistry theSearchParamRegistry)

setMyMetaTagSorter

public void setMyMetaTagSorter(IMetaTagSorter theMetaTagSorter)

preProcessResourceForStorage

protected void preProcessResourceForStorage(org.hl7.fhir.instance.model.api.IBaseResource theResource)

Deprecated.

Use preProcessResourceForStorage(IBaseResource, RequestDetails, TransactionDetails, boolean) instead

May be overridden by subclasses to validate resources prior to storage

Parameters:

theResource - The resource that is about to be stored

preProcessResourceForStorage

protected void preProcessResourceForStorage(org.hl7.fhir.instance.model.api.IBaseResource theResource,
 ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails,
 ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails,
 boolean thePerformIndexing)

May be overridden by subclasses to validate resources prior to storage

Parameters:

theResource - The resource that is about to be stored

Since:

5.3.0

verifyResourceIdIsValid

protected void verifyResourceIdIsValid(org.hl7.fhir.instance.model.api.IBaseResource theResource)

Verify that the resource ID is actually valid according to FHIR's rules

toMethodOutcome

protected DaoMethodOutcome toMethodOutcome(ca.uhn.fhir.rest.api.server.RequestDetails theRequest,
 @Nonnull
 IBasePersistedResource theEntity,
 @Nonnull
 org.hl7.fhir.instance.model.api.IBaseResource theResource,
 @Nullable
 String theMatchUrl,
 @Nonnull
 ca.uhn.fhir.rest.api.RestOperationTypeEnum theOperationType)

toMethodOutcomeLazy

protected DaoMethodOutcome toMethodOutcomeLazy(ca.uhn.fhir.rest.api.server.RequestDetails theRequest,
 ca.uhn.fhir.rest.api.server.storage.IResourcePersistentId theResourcePersistentId,
 @Nonnull
 Supplier<LazyDaoMethodOutcome.EntityAndResource> theEntity,
 Supplier<org.hl7.fhir.instance.model.api.IIdType> theIdSupplier)

doCallHooks

protected void doCallHooks(ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails,
 ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails,
 ca.uhn.fhir.interceptor.api.Pointcut thePointcut,
 ca.uhn.fhir.interceptor.api.HookParams theParams)

getInterceptorBroadcaster

protected abstract ca.uhn.fhir.interceptor.api.IInterceptorBroadcaster getInterceptorBroadcaster()

createErrorOperationOutcome

public org.hl7.fhir.instance.model.api.IBaseOperationOutcome createErrorOperationOutcome(String theMessage,
 String theCode)

createInfoOperationOutcome

public org.hl7.fhir.instance.model.api.IBaseOperationOutcome createInfoOperationOutcome(String theMessage)

createInfoOperationOutcome

public org.hl7.fhir.instance.model.api.IBaseOperationOutcome createInfoOperationOutcome(String theMessage,
 @Nullable
 ca.uhn.fhir.model.api.StorageResponseCodeEnum theStorageResponseCode)

createWarnOperationOutcome

@Nonnull
public org.hl7.fhir.instance.model.api.IBaseOperationOutcome createWarnOperationOutcome(String theMsg,
 String theCode,
 ca.uhn.fhir.model.api.StorageResponseCodeEnum theResponseCodeEnum)

createMethodOutcomeForResourceId

protected DaoMethodOutcome createMethodOutcomeForResourceId(String theResourceId,
 String theMessageKey,
 ca.uhn.fhir.model.api.StorageResponseCodeEnum theStorageResponseCode)

Creates a base method outcome for a delete request for the provided ID.

Additional information may be set on the outcome.

Parameters:

theResourceId - - the id of the object being deleted. Eg: Patient/123

createResourceGoneException

@Nonnull
protected ca.uhn.fhir.rest.server.exceptions.ResourceGoneException createResourceGoneException(IBasePersistedResource theResourceEntity)

getStorageSettings

protected abstract JpaStorageSettings getStorageSettings()

Provide the JpaStorageSettings

getResourceName

@Nullable
protected abstract String getResourceName()

Returns the resource type for this DAO, or null if this is a system-level DAO

getContext

protected abstract ca.uhn.fhir.context.FhirContext getContext()

Provides the FHIR context

translateRawParameters

@Transactional(propagation=SUPPORTS)
public void translateRawParameters(Map<String,List<String>> theSource,
 SearchParameterMap theTarget)

populateOperationOutcomeForUpdate

protected void populateOperationOutcomeForUpdate(@Nullable
 ca.uhn.fhir.util.StopWatch theItemStopwatch,
 DaoMethodOutcome theMethodOutcome,
 String theMatchUrl,
 ca.uhn.fhir.rest.api.RestOperationTypeEnum theOperationType,
 ca.uhn.fhir.rest.api.server.storage.TransactionDetails theTransactionDetails)

addIssueToOperationOutcomeForAutoCreatedPlaceholder

public static String addIssueToOperationOutcomeForAutoCreatedPlaceholder(ca.uhn.fhir.context.FhirContext theFhirContext,
 org.hl7.fhir.instance.model.api.IIdType thePlaceholderId,
 org.hl7.fhir.instance.model.api.IBaseOperationOutcome theOperationOutcomeToPopulate)

extractReferencesToAvoidReplacement

public static Set<org.hl7.fhir.instance.model.api.IBaseReference> extractReferencesToAvoidReplacement(ca.uhn.fhir.context.FhirContext theFhirContext,
 org.hl7.fhir.instance.model.api.IBaseResource theResource)

Extracts a list of references that have versions in their ID whose versions should not be stripped

Returns:

A set of references that should not have their client-given versions stripped according to the versioned references settings.

extractReferencesToAutoVersion

@Nonnull
public static Set<org.hl7.fhir.instance.model.api.IBaseReference> extractReferencesToAutoVersion(ca.uhn.fhir.context.FhirContext theFhirContext,
 StorageSettings theStorageSettings,
 org.hl7.fhir.instance.model.api.IBaseResource theResource)

Extracts a list of references that should be auto-versioned.

Returns:

A set of references that should be versioned according to both storage settings and auto-version reference extensions, or it may also be empty.

clearRequestAsProcessingSubRequest

public static void clearRequestAsProcessingSubRequest(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)

markRequestAsProcessingSubRequest

public static void markRequestAsProcessingSubRequest(ca.uhn.fhir.rest.api.server.RequestDetails theRequestDetails)