DaoConfig (HAPI FHIR JPA Server 2.4 API)

java.lang.Object
- ca.uhn.fhir.jpa.dao.DaoConfig

```
public class DaoConfig
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

static Set<String> DEFAULT_LOGICAL_BASE_URLS
Default logical URL bases.

Fields
Modifier and Type	Field and Description
`static Set<String>`	`DEFAULT_LOGICAL_BASE_URLS` Default `logical URL bases`.

Constructor Summary

Constructors
Constructor and Description

DaoConfig()

Constructors
Constructor and Description
`DaoConfig()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addTreatReferencesAsLogical(String theTreatReferencesAsLogical)` Add a value to the `logical references list`.
`int`	`getDeferIndexingForCodesystemsOfSize()` When a code system is added that contains more than this number of codes, the code system will be indexed later in an incremental process in order to avoid overwhelming Lucene with a huge number of codes in a single operation.
`long`	`getExpireSearchResultsAfterMillis()` Sets the number of milliseconds that search results for a given client search should be preserved before being purged from the database.
`int`	`getHardTagListLimit()` Gets the maximum number of results to return in a GetTags query (DSTU1 only)
`int`	`getIncludeLimit()`
`List<IServerInterceptor>`	`getInterceptors()` Deprecated. As of 2.2 this method is deprecated. There is no good reason to register an interceptor with the DaoConfig and not with the server via `RestfulServer.registerInterceptor(IServerInterceptor)`
`int`	`getMaximumExpansionSize()` See `setMaximumExpansionSize(int)`
`ResourceEncodingEnum`	`getResourceEncoding()`
`long`	`getSubscriptionPollDelay()`
`Long`	`getSubscriptionPurgeInactiveAfterMillis()`
`Set<String>`	`getTreatBaseUrlsAsLocal()` This setting may be used to advise the server that any references found in resources that have any of the base URLs given here will be replaced with simple local references.
`Set<String>`	`getTreatReferencesAsLogical()` This setting may be used to advise the server that any references found in resources that have any of the base URLs given here will be treated as logical references instead of being treated as real references.
`boolean`	`isAllowExternalReferences()` If set to `true` (default is `false`) the server will allow resources to have references to external servers.
`boolean`	`isAllowInlineMatchUrlReferences()`
`boolean`	`isAllowMultipleDelete()`
`boolean`	`isDefaultSearchParamsCanBeOverridden()` If set to `true` the default search params (i.e.
`boolean`	`isExpireSearchResults()` If this is set to `false` (default is `true`) the stale search deletion task will be disabled (meaning that search results will be retained in the database indefinitely).
`boolean`	`isIndexContainedResources()` Should contained IDs be indexed the same way that non-contained IDs are (default is `true`)
`boolean`	`isSchedulingDisabled()`
`boolean`	`isSubscriptionEnabled()` See `setSubscriptionEnabled(boolean)`
`void`	`setAllowExternalReferences(boolean theAllowExternalReferences)` If set to `true` (default is `false`) the server will allow resources to have references to external servers.
`void`	`setAllowInlineMatchUrlReferences(boolean theAllowInlineMatchUrlReferences)` Should references containing match URLs be resolved and replaced in create and update operations.
`void`	`setAllowMultipleDelete(boolean theAllowMultipleDelete)`
`void`	`setDefaultSearchParamsCanBeOverridden(boolean theDefaultSearchParamsCanBeOverridden)` If set to `true` the default search params (i.e.
`void`	`setDeferIndexingForCodesystemsOfSize(int theDeferIndexingForCodesystemsOfSize)` When a code system is added that contains more than this number of codes, the code system will be indexed later in an incremental process in order to avoid overwhelming Lucene with a huge number of codes in a single operation.
`void`	`setExpireSearchResults(boolean theDeleteStaleSearches)` If this is set to `false` (default is `true`) the stale search deletion task will be disabled (meaning that search results will be retained in the database indefinitely).
`void`	`setExpireSearchResultsAfterMillis(long theExpireSearchResultsAfterMillis)` Sets the number of milliseconds that search results for a given client search should be preserved before being purged from the database.
`void`	`setHardSearchLimit(int theHardSearchLimit)` Deprecated. This method does not do anything. Configure the page size on your paging provider instead. Deprecated in HAPI FHIR 2.3 (Jan 2017)
`void`	`setHardTagListLimit(int theHardTagListLimit)` Gets the maximum number of results to return in a GetTags query (DSTU1 only)
`void`	`setIncludeLimit(int theIncludeLimit)` This is the maximum number of resources that will be added to a single page of returned resources.
`void`	`setIndexContainedResources(boolean theIndexContainedResources)` Should contained IDs be indexed the same way that non-contained IDs are (default is `true`)
`void`	`setInterceptors(IServerInterceptor... theInterceptor)` Deprecated. As of 2.2 this method is deprecated. There is no good reason to register an interceptor with the DaoConfig and not with the server via `RestfulServer.registerInterceptor(IServerInterceptor)`
`void`	`setInterceptors(List<IServerInterceptor> theInterceptors)` Deprecated. As of 2.2 this method is deprecated. There is no good reason to register an interceptor with the DaoConfig and not with the server via `RestfulServer.registerInterceptor(IServerInterceptor)`
`void`	`setMaximumExpansionSize(int theMaximumExpansionSize)` Sets the maximum number of codes that will be added to a valueset expansion before the operation will be failed as too costly
`void`	`setResourceEncoding(ResourceEncodingEnum theResourceEncoding)`
`void`	`setSchedulingDisabled(boolean theSchedulingDisabled)`
`void`	`setSubscriptionEnabled(boolean theSubscriptionEnabled)` If set to true, the server will enable support for subscriptions.
`void`	`setSubscriptionPollDelay(long theSubscriptionPollDelay)`
`void`	`setSubscriptionPurgeInactiveAfterMillis(Long theMillis)`
`void`	`setSubscriptionPurgeInactiveAfterSeconds(int theSeconds)`
`void`	`setTreatBaseUrlsAsLocal(Set<String> theTreatBaseUrlsAsLocal)` This setting may be used to advise the server that any references found in resources that have any of the base URLs given here will be replaced with simple local references.
`DaoConfig`	`setTreatReferencesAsLogical(Set<String> theTreatReferencesAsLogical)` This setting may be used to advise the server that any references found in resources that have any of the base URLs given here will be treated as logical references instead of being treated as real references.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEFAULT_LOGICAL_BASE_URLS
```
public static final Set<String> DEFAULT_LOGICAL_BASE_URLS
```
    Default logical URL bases. Includes the following values:
    - "http://hl7.org/fhir/valueset-*"
    - "http://hl7.org/fhir/codesystem-*"
    - "http://hl7.org/fhir/StructureDefinition/*"
- Constructor Detail
  - DaoConfig
```
public DaoConfig()
```
- Method Detail
  - addTreatReferencesAsLogical
```
public void addTreatReferencesAsLogical(String theTreatReferencesAsLogical)
```
    Add a value to the logical references list.
    
    See Also:
    
    setTreatReferencesAsLogical(Set)
  - getDeferIndexingForCodesystemsOfSize
```
public int getDeferIndexingForCodesystemsOfSize()
```
    When a code system is added that contains more than this number of codes, the code system will be indexed later in an incremental process in order to avoid overwhelming Lucene with a huge number of codes in a single operation.
    Defaults to 2000
  - getExpireSearchResultsAfterMillis
```
public long getExpireSearchResultsAfterMillis()
```
    Sets the number of milliseconds that search results for a given client search should be preserved before being purged from the database.
    Search results are stored in the database so that they can be paged over multiple requests. After this number of milliseconds, they will be deleted from the database, and any paging links (next/prev links in search response bundles) will become invalid. Defaults to 1 hour.
    
    To disable this feature entirely, see setExpireSearchResults(boolean)
    
    Since:
    
    1.5
  - getHardTagListLimit
```
public int getHardTagListLimit()
```
    Gets the maximum number of results to return in a GetTags query (DSTU1 only)
  - getIncludeLimit
```
public int getIncludeLimit()
```
  - getInterceptors
```
@Deprecated
public List<IServerInterceptor> getInterceptors()
```
    Deprecated. As of 2.2 this method is deprecated. There is no good reason to register an interceptor with the DaoConfig and not with the server via RestfulServer.registerInterceptor(IServerInterceptor)
    
    Returns the interceptors which will be notified of operations.
    
    See Also:
    
    setInterceptors(List)
  - getMaximumExpansionSize
```
public int getMaximumExpansionSize()
```
    See setMaximumExpansionSize(int)
  - getResourceEncoding
```
public ResourceEncodingEnum getResourceEncoding()
```
  - getSubscriptionPollDelay
```
public long getSubscriptionPollDelay()
```
  - getSubscriptionPurgeInactiveAfterMillis
```
public Long getSubscriptionPurgeInactiveAfterMillis()
```
  - getTreatBaseUrlsAsLocal
```
public Set<String> getTreatBaseUrlsAsLocal()
```
    This setting may be used to advise the server that any references found in resources that have any of the base URLs given here will be replaced with simple local references.
    For example, if the set contains the value http://example.com/base/ and a resource is submitted to the server that contains a reference to http://example.com/base/Patient/1, the server will automatically convert this reference to Patient/1
    
    Note that this property has different behaviour from getTreatReferencesAsLogical()
    
    See Also:
    
    getTreatReferencesAsLogical()
  - getTreatReferencesAsLogical
```
public Set<String> getTreatReferencesAsLogical()
```
    This setting may be used to advise the server that any references found in resources that have any of the base URLs given here will be treated as logical references instead of being treated as real references.
    A logical reference is a reference which is treated as an identifier, and does not neccesarily resolve. See "http://hl7.org/fhir/references.html" for a description of logical references. For example, the valueset "http://hl7.org/fhir/valueset-quantity-comparator.html" is a logical reference.
    
    Values for this field may take either of the following forms:
    - http://example.com/some-url (will be matched exactly)
    - http://example.com/some-base* (will match anything beginning with the part before the *)
    See Also:
    
    Default values for this property
  - isAllowExternalReferences
```
public boolean isAllowExternalReferences()
```
    If set to true (default is false) the server will allow resources to have references to external servers. For example if this server is running at http://example.com/fhir and this setting is set to true the server will allow a Patient resource to be saved with a Patient.organization value of http://foo.com/Organization/1.
    Under the default behaviour if this value has not been changed, the above resource would be rejected by the server because it requires all references to be resolvable on the local server.
    
    Note that external references will be indexed by the server and may be searched (e.g. Patient:organization), but chained searches (e.g. Patient:organization.name) will not work across these references.
    
    It is recommended to also set setTreatBaseUrlsAsLocal(Set) if this value is set to true
    
    See Also:
    
    setTreatBaseUrlsAsLocal(Set), setAllowExternalReferences(boolean)
  - isAllowInlineMatchUrlReferences
```
public boolean isAllowInlineMatchUrlReferences()
```
    See Also:
    
    setAllowInlineMatchUrlReferences(boolean)
  - isAllowMultipleDelete
```
public boolean isAllowMultipleDelete()
```
  - isDefaultSearchParamsCanBeOverridden
```
public boolean isDefaultSearchParamsCanBeOverridden()
```
    If set to true the default search params (i.e. the search parameters that are defined by the FHIR specification itself) may be overridden by uploading search parameters to the server with the same code as the built-in search parameter.
    This can be useful if you want to be able to disable or alter the behaviour of the default search parameters.
    
    The default value for this setting is false
  - isExpireSearchResults
```
public boolean isExpireSearchResults()
```
    If this is set to false (default is true) the stale search deletion task will be disabled (meaning that search results will be retained in the database indefinitely). USE WITH CAUTION.
    This feature is useful if you want to define your own process for deleting these (e.g. because you are running in a cluster)
  - isIndexContainedResources
```
public boolean isIndexContainedResources()
```
    Should contained IDs be indexed the same way that non-contained IDs are (default is true)
  - isSchedulingDisabled
```
public boolean isSchedulingDisabled()
```
  - isSubscriptionEnabled
```
public boolean isSubscriptionEnabled()
```
    See setSubscriptionEnabled(boolean)
  - setAllowExternalReferences
```
public void setAllowExternalReferences(boolean theAllowExternalReferences)
```
    If set to true (default is false) the server will allow resources to have references to external servers. For example if this server is running at http://example.com/fhir and this setting is set to true the server will allow a Patient resource to be saved with a Patient.organization value of http://foo.com/Organization/1.
    Under the default behaviour if this value has not been changed, the above resource would be rejected by the server because it requires all references to be resolvable on the local server.
    
    Note that external references will be indexed by the server and may be searched (e.g. Patient:organization), but chained searches (e.g. Patient:organization.name) will not work across these references.
    
    It is recommended to also set setTreatBaseUrlsAsLocal(Set) if this value is set to true
    
    See Also:
    
    setTreatBaseUrlsAsLocal(Set), setAllowExternalReferences(boolean)
  - setAllowInlineMatchUrlReferences
```
public void setAllowInlineMatchUrlReferences(boolean theAllowInlineMatchUrlReferences)
```
    Should references containing match URLs be resolved and replaced in create and update operations. For example, if this property is set to true and a resource is created containing a reference to "Patient?identifier=12345", this is reference match URL will be resolved and replaced according to the usual match URL rules.
    Default is true beginning in HAPI FHIR 2.4, since this feature is now specified in the FHIR specification. (Previously it was an experimental/rpposed feature)
    
    Since:
    
    1.5
  - setAllowMultipleDelete
```
public void setAllowMultipleDelete(boolean theAllowMultipleDelete)
```
  - setDefaultSearchParamsCanBeOverridden
```
public void setDefaultSearchParamsCanBeOverridden(boolean theDefaultSearchParamsCanBeOverridden)
```
    If set to true the default search params (i.e. the search parameters that are defined by the FHIR specification itself) may be overridden by uploading search parameters to the server with the same code as the built-in search parameter.
    This can be useful if you want to be able to disable or alter the behaviour of the default search parameters.
    
    The default value for this setting is false
  - setDeferIndexingForCodesystemsOfSize
```
public void setDeferIndexingForCodesystemsOfSize(int theDeferIndexingForCodesystemsOfSize)
```
    When a code system is added that contains more than this number of codes, the code system will be indexed later in an incremental process in order to avoid overwhelming Lucene with a huge number of codes in a single operation.
    Defaults to 2000
  - setExpireSearchResults
```
public void setExpireSearchResults(boolean theDeleteStaleSearches)
```
    If this is set to false (default is true) the stale search deletion task will be disabled (meaning that search results will be retained in the database indefinitely). USE WITH CAUTION.
    This feature is useful if you want to define your own process for deleting these (e.g. because you are running in a cluster)
  - setExpireSearchResultsAfterMillis
```
public void setExpireSearchResultsAfterMillis(long theExpireSearchResultsAfterMillis)
```
    Sets the number of milliseconds that search results for a given client search should be preserved before being purged from the database.
    Search results are stored in the database so that they can be paged over multiple requests. After this number of milliseconds, they will be deleted from the database, and any paging links (next/prev links in search response bundles) will become invalid. Defaults to 1 hour.
    
    To disable this feature entirely, see setExpireSearchResults(boolean)
    
    Since:
    
    1.5
  - setHardSearchLimit
```
@Deprecated
public void setHardSearchLimit(int theHardSearchLimit)
```
    Deprecated. This method does not do anything. Configure the page size on your paging provider instead. Deprecated in HAPI FHIR 2.3 (Jan 2017)
    
    Do not call this method, it exists only for legacy reasons. It will be removed in a future version. Configure the page size on your paging provider instead.
  - setHardTagListLimit
```
public void setHardTagListLimit(int theHardTagListLimit)
```
    Gets the maximum number of results to return in a GetTags query (DSTU1 only)
  - setIncludeLimit
```
public void setIncludeLimit(int theIncludeLimit)
```
    This is the maximum number of resources that will be added to a single page of returned resources. Because of includes with wildcards and other possibilities it is possible for a client to make requests that include very large amounts of data, so this hard limit can be imposed to prevent runaway requests.
  - setIndexContainedResources
```
public void setIndexContainedResources(boolean theIndexContainedResources)
```
    Should contained IDs be indexed the same way that non-contained IDs are (default is true)
  - setInterceptors
```
@Deprecated
public void setInterceptors(IServerInterceptor... theInterceptor)
```
    Deprecated. As of 2.2 this method is deprecated. There is no good reason to register an interceptor with the DaoConfig and not with the server via RestfulServer.registerInterceptor(IServerInterceptor)
    
    This may be used to optionally register server interceptors directly against the DAOs.
  - setInterceptors
```
@Deprecated
public void setInterceptors(List<IServerInterceptor> theInterceptors)
```
    Deprecated. As of 2.2 this method is deprecated. There is no good reason to register an interceptor with the DaoConfig and not with the server via RestfulServer.registerInterceptor(IServerInterceptor)
    
    This may be used to optionally register server interceptors directly against the DAOs.
  - setMaximumExpansionSize
```
public void setMaximumExpansionSize(int theMaximumExpansionSize)
```
    Sets the maximum number of codes that will be added to a valueset expansion before the operation will be failed as too costly
  - setResourceEncoding
```
public void setResourceEncoding(ResourceEncodingEnum theResourceEncoding)
```
  - setSchedulingDisabled
```
public void setSchedulingDisabled(boolean theSchedulingDisabled)
```
  - setSubscriptionEnabled
```
public void setSubscriptionEnabled(boolean theSubscriptionEnabled)
```
    If set to true, the server will enable support for subscriptions. Subscriptions will by default be handled via a polling task. Note that if this is enabled, you must also include Spring task scanning to your XML config for the scheduled tasks used by the subscription module.
  - setSubscriptionPollDelay
```
public void setSubscriptionPollDelay(long theSubscriptionPollDelay)
```
  - setSubscriptionPurgeInactiveAfterMillis
```
public void setSubscriptionPurgeInactiveAfterMillis(Long theMillis)
```
  - setSubscriptionPurgeInactiveAfterSeconds
```
public void setSubscriptionPurgeInactiveAfterSeconds(int theSeconds)
```
  - setTreatBaseUrlsAsLocal
```
public void setTreatBaseUrlsAsLocal(Set<String> theTreatBaseUrlsAsLocal)
```
    This setting may be used to advise the server that any references found in resources that have any of the base URLs given here will be replaced with simple local references.
    For example, if the set contains the value http://example.com/base/ and a resource is submitted to the server that contains a reference to http://example.com/base/Patient/1, the server will automatically convert this reference to Patient/1
    
    Parameters:
    
    theTreatBaseUrlsAsLocal - The set of base URLs. May be null, which means no references will be treated as external
  - setTreatReferencesAsLogical
```
public DaoConfig setTreatReferencesAsLogical(Set<String> theTreatReferencesAsLogical)
```
    This setting may be used to advise the server that any references found in resources that have any of the base URLs given here will be treated as logical references instead of being treated as real references.
    A logical reference is a reference which is treated as an identifier, and does not neccesarily resolve. See "http://hl7.org/fhir/references.html" for a description of logical references. For example, the valueset "http://hl7.org/fhir/valueset-quantity-comparator.html" is a logical reference.
    
    Values for this field may take either of the following forms:
    - http://example.com/some-url (will be matched exactly)
    - http://example.com/some-base* (will match anything beginning with the part before the *)
    See Also:
    
    Default values for this property

Class DaoConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_LOGICAL_BASE_URLS

Constructor Detail

DaoConfig

Method Detail

addTreatReferencesAsLogical

getDeferIndexingForCodesystemsOfSize

getExpireSearchResultsAfterMillis

getHardTagListLimit

getIncludeLimit

getInterceptors

getMaximumExpansionSize

getResourceEncoding

getSubscriptionPollDelay

getSubscriptionPurgeInactiveAfterMillis

getTreatBaseUrlsAsLocal

getTreatReferencesAsLogical

isAllowExternalReferences

isAllowInlineMatchUrlReferences

isAllowMultipleDelete

isDefaultSearchParamsCanBeOverridden

isExpireSearchResults

isIndexContainedResources

isSchedulingDisabled

isSubscriptionEnabled

setAllowExternalReferences

setAllowInlineMatchUrlReferences

setAllowMultipleDelete

setDefaultSearchParamsCanBeOverridden

setDeferIndexingForCodesystemsOfSize

setExpireSearchResults

setExpireSearchResultsAfterMillis

setHardSearchLimit

setHardTagListLimit

setIncludeLimit

setIndexContainedResources

setInterceptors

setInterceptors

setMaximumExpansionSize

setResourceEncoding

setSchedulingDisabled

setSubscriptionEnabled

setSubscriptionPollDelay

setSubscriptionPurgeInactiveAfterMillis

setSubscriptionPurgeInactiveAfterSeconds

setTreatBaseUrlsAsLocal

setTreatReferencesAsLogical