Package org.apache.cayenne.configuration
Interface Constants
public interface Constants
Defines the names of runtime properties and named collections used in DI modules.
- Since:
- 3.1
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
A DI container key for the List<DbAdapterDetector> that contains objects that can discover the type of current database and install the correct DbAdapter in runtime.static final String
Defines if database uses case-insensitive collationstatic final String
A boolean property defining whether cross-contexts synchronization is enabled.static final String
A DI container key for the List<ExtendedType> storing default adapter-agnostic ExtendedTypes.static final String
A DI container key for the List<Object> storing lifecycle events listeners.static final String
An optional name of the runtime DataDomain.static final String
A boolean property that defines whether runtime should use external transactions.static final String
static final String
static final String
Defines a maximum time in milliseconds that a connection request could wait in the connection queue.static final String
static final String
static final String
static final String
static final String
static final String
A property that defines a maximum number of ID qualifiers in where clause of queries that are generated for example inIncrementalFaultList
or in DISJOINT_BY_ID prefetch processing.static final String
A String property that defines how ObjectContexts should retain cached committed objects.static final String
A DI container key for the List<String> storing locations of the one of more project configuration files.static final String
A DI container key for the Map<String, String> storing properties used by built-in Cayenne service.static final String
An integer property defining the maximum number of entries in the query cache.static final String
A integer property that enables logging for just long running queries (rather than all queries).static final String
A DI container key for bindingResourceLocator
static final String
Deprecated, for removal: This API element is subject to removal in a future version.static final String
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useCONTEXTS_SYNC_PROPERTY
static final String
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useDEFAULT_TYPES_LIST
static final String
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useDOMAIN_LISTENERS_LIST
static final String
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useDOMAIN_NAME_PROPERTY
static final String
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useEXTERNAL_TX_PROPERTY
static final String
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useMAX_ID_QUALIFIER_SIZE_PROPERTY
static final String
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useCONTEXTS_SYNC_PROPERTY
static final String
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, usePROJECT_LOCATIONS_LIST
static final String
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useRESOURCE_LOCATOR
static final String
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useTYPE_FACTORIES_LIST
static final String
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useUSER_TYPES_LIST
static final String
Snapshot cache max sizestatic final String
A DI container key for the List<ExtendedTypeFactory> storing default and user-provided ExtendedTypeFactories.static final String
A DI container key for the List<ExtendedType> storing a user-provided ExtendedTypes.
-
Field Details
-
PROPERTIES_MAP
A DI container key for the Map<String, String> storing properties used by built-in Cayenne service.- See Also:
-
ADAPTER_DETECTORS_LIST
A DI container key for the List<DbAdapterDetector> that contains objects that can discover the type of current database and install the correct DbAdapter in runtime.- See Also:
-
SERVER_ADAPTER_DETECTORS_LIST
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useADAPTER_DETECTORS_LIST
- See Also:
-
DOMAIN_LISTENERS_LIST
A DI container key for the List<Object> storing lifecycle events listeners.- See Also:
-
SERVER_DOMAIN_LISTENERS_LIST
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useDOMAIN_LISTENERS_LIST
- See Also:
-
PROJECT_LOCATIONS_LIST
A DI container key for the List<String> storing locations of the one of more project configuration files.- See Also:
-
SERVER_PROJECT_LOCATIONS_LIST
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, usePROJECT_LOCATIONS_LIST
- See Also:
-
DEFAULT_TYPES_LIST
A DI container key for the List<ExtendedType> storing default adapter-agnostic ExtendedTypes.- See Also:
-
SERVER_DEFAULT_TYPES_LIST
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useDEFAULT_TYPES_LIST
- See Also:
-
USER_TYPES_LIST
A DI container key for the List<ExtendedType> storing a user-provided ExtendedTypes.- See Also:
-
SERVER_USER_TYPES_LIST
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useUSER_TYPES_LIST
- See Also:
-
TYPE_FACTORIES_LIST
A DI container key for the List<ExtendedTypeFactory> storing default and user-provided ExtendedTypeFactories.- See Also:
-
SERVER_TYPE_FACTORIES_LIST
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useTYPE_FACTORIES_LIST
- See Also:
-
RESOURCE_LOCATOR
A DI container key for bindingResourceLocator
- See Also:
-
SERVER_RESOURCE_LOCATOR
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useRESOURCE_LOCATOR
- See Also:
-
JDBC_DRIVER_PROPERTY
- See Also:
-
JDBC_URL_PROPERTY
- See Also:
-
JDBC_USERNAME_PROPERTY
- See Also:
-
JDBC_PASSWORD_PROPERTY
- See Also:
-
JDBC_MIN_CONNECTIONS_PROPERTY
- See Also:
-
JDBC_MAX_CONNECTIONS_PROPERTY
- See Also:
-
JDBC_MAX_QUEUE_WAIT_TIME
Defines a maximum time in milliseconds that a connection request could wait in the connection queue. After this period expires, an exception will be thrown in the calling method. A value of zero will make the thread wait until a connection is available with no time out. Defaults to 20 seconds.- Since:
- 4.0
- See Also:
-
JDBC_VALIDATION_QUERY_PROPERTY
- Since:
- 4.0
- See Also:
-
QUERY_CACHE_SIZE_PROPERTY
An integer property defining the maximum number of entries in the query cache. Note that not all QueryCache providers may respect this property. MapQueryCache uses it, but the rest would use alternative configuration methods.- See Also:
-
DOMAIN_NAME_PROPERTY
An optional name of the runtime DataDomain. If not specified (which is normally the case), the name is inferred from the configuration name.- Since:
- 4.0
- See Also:
-
SERVER_DOMAIN_NAME_PROPERTY
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useDOMAIN_NAME_PROPERTY
- See Also:
-
CONTEXTS_SYNC_PROPERTY
A boolean property defining whether cross-contexts synchronization is enabled. Possible values are "true" or "false".- See Also:
-
SERVER_CONTEXTS_SYNC_PROPERTY
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useCONTEXTS_SYNC_PROPERTY
- See Also:
-
OBJECT_RETAIN_STRATEGY_PROPERTY
A String property that defines how ObjectContexts should retain cached committed objects. Possible values are "weak", "soft", "hard".- See Also:
-
SERVER_OBJECT_RETAIN_STRATEGY_PROPERTY
@Deprecated(since="5.0", forRemoval=true) static final String SERVER_OBJECT_RETAIN_STRATEGY_PROPERTYDeprecated, for removal: This API element is subject to removal in a future version.since 5.0, useCONTEXTS_SYNC_PROPERTY
- See Also:
-
EXTERNAL_TX_PROPERTY
A boolean property that defines whether runtime should use external transactions. Possible values are "true" or "false".- See Also:
-
SERVER_EXTERNAL_TX_PROPERTY
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useEXTERNAL_TX_PROPERTY
- See Also:
-
MAX_ID_QUALIFIER_SIZE_PROPERTY
A property that defines a maximum number of ID qualifiers in where clause of queries that are generated for example inIncrementalFaultList
or in DISJOINT_BY_ID prefetch processing. This is needed to avoid where clause size limitations and memory usage efficiency.- See Also:
-
SERVER_MAX_ID_QUALIFIER_SIZE_PROPERTY
Deprecated, for removal: This API element is subject to removal in a future version.since 5.0, useMAX_ID_QUALIFIER_SIZE_PROPERTY
- See Also:
-
CI_PROPERTY
Defines if database uses case-insensitive collation- See Also:
-
QUERY_EXECUTION_TIME_LOGGING_THRESHOLD_PROPERTY
A integer property that enables logging for just long running queries (rather than all queries). The value is the minimum number of milliseconds a query must run before is logged. A value less than or equal to zero (the default) disables this feature.- Since:
- 4.0
- See Also:
-
SNAPSHOT_CACHE_SIZE_PROPERTY
Snapshot cache max size- Since:
- 4.0
- See Also:
-
ADAPTER_DETECTORS_LIST