Package ca.uhn.fhir.jpa.api.config

Enum JpaStorageSettings.ClientIdStrategyEnum

java.lang.Object

java.lang.Enum<JpaStorageSettings.ClientIdStrategyEnum>

ca.uhn.fhir.jpa.api.config.JpaStorageSettings.ClientIdStrategyEnum

All Implemented Interfaces:

Serializable, Comparable<JpaStorageSettings.ClientIdStrategyEnum>

Enclosing class:

JpaStorageSettings

public static enum JpaStorageSettings.ClientIdStrategyEnum
extends Enum<JpaStorageSettings.ClientIdStrategyEnum>

This enum provides allowable options for JpaStorageSettings.setResourceClientIdStrategy(ClientIdStrategyEnum)

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALPHANUMERIC	Clients may supply IDs but these IDs are not permitted to be purely numeric.
ANY	Clients may supply any ID including purely numeric IDs.
NOT_ALLOWED	Clients are not allowed to supply IDs for resources that do not already exist

Method Summary

Modifier and Type	Method	Description
static JpaStorageSettings.ClientIdStrategyEnum	valueOf(String name)	Returns the enum constant of this type with the specified name.
static JpaStorageSettings.ClientIdStrategyEnum[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NOT_ALLOWED

public static final JpaStorageSettings.ClientIdStrategyEnum NOT_ALLOWED

Clients are not allowed to supply IDs for resources that do not already exist

ALPHANUMERIC

public static final JpaStorageSettings.ClientIdStrategyEnum ALPHANUMERIC

Clients may supply IDs but these IDs are not permitted to be purely numeric. In other words, values such as "A", "A1" and "000A" would be considered valid but "123" would not.

This is the default setting.

ANY

public static final JpaStorageSettings.ClientIdStrategyEnum ANY

Clients may supply any ID including purely numeric IDs. Note that this setting should only be set on an empty database, or on a database that has always had this setting set as it causes a "forced ID" to be used for all resources.

Note that if you use this setting, it is highly recommended that you also set the ResourceServerIdStrategy to JpaStorageSettings.IdStrategyEnum.UUID in order to avoid any potential for conflicts. Otherwise a database sequence will be used to generate IDs and these IDs can conflict with client-assigned numeric IDs.

Method Details

values

public static JpaStorageSettings.ClientIdStrategyEnum[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static JpaStorageSettings.ClientIdStrategyEnum valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null