Package org.apache.cayenne.configuration
Interface Constants
-
public interface ConstantsDefines the names of runtime properties and named collections used in DI modules.- Since:
- 3.1
-
-
Field Summary
Fields Modifier and Type Field Description static StringCI_PROPERTYDefines if database uses case-insensitive collationstatic StringJDBC_DRIVER_PROPERTYstatic StringJDBC_MAX_CONNECTIONS_PROPERTYstatic StringJDBC_MAX_QUEUE_WAIT_TIMEDefines a maximum time in milliseconds that a connection request could wait in the connection queue.static StringJDBC_MIN_CONNECTIONS_PROPERTYstatic StringJDBC_PASSWORD_PROPERTYstatic StringJDBC_URL_PROPERTYstatic StringJDBC_USERNAME_PROPERTYstatic StringJDBC_VALIDATION_QUERY_PROPERTYstatic StringPROPERTIES_MAPA DI container key for the Map<String, String> storing properties used by built-in Cayenne service.static StringQUERY_CACHE_SIZE_PROPERTYAn integer property defining the maximum number of entries in the query cache.static StringQUERY_EXECUTION_TIME_LOGGING_THRESHOLD_PROPERTYA integer property that enables logging for just long running queries (rather than all queries).static StringSERVER_ADAPTER_DETECTORS_LISTA 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 StringSERVER_CONTEXTS_SYNC_PROPERTYA boolean property defining whether cross-contexts synchronization is enabled.static StringSERVER_DEFAULT_TYPES_LISTA DI container key for the List<ExtendedType> storing default adapter-agnostic ExtendedTypes.static StringSERVER_DOMAIN_FILTERS_LISTDeprecated.since 4.1 domain filters replaced with query and sync filtersstatic StringSERVER_DOMAIN_LISTENERS_LISTA DI container key for the List<Object> storing lifecycle events listeners.static StringSERVER_DOMAIN_NAME_PROPERTYAn optional name of the runtime DataDomain.static StringSERVER_EXTERNAL_TX_PROPERTYA boolean property that defines whether runtime should use external transactions.static StringSERVER_MAX_ID_QUALIFIER_SIZE_PROPERTYA property that defines a maximum number of ID qualifiers in where clause of queries that are generated for example inIncrementalFaultListor in DISJOINT_BY_ID prefetch processing.static StringSERVER_MAX_QUEUE_WAIT_TIMEDeprecated.since 4.0 renamed toJDBC_MAX_QUEUE_WAIT_TIME.static StringSERVER_OBJECT_RETAIN_STRATEGY_PROPERTYA String property that defines how ObjectContexts should retain cached committed objects.static StringSERVER_PROJECT_LOCATIONS_LISTA DI container key for the List<String> storing locations of the one of more project configuration files.static StringSERVER_RESOURCE_LOCATORA server-side DI container key for bindingResourceLocatorstatic StringSERVER_ROP_EVENT_BRIDGE_FACTORY_PROPERTYThe name of theEventBridgeFactorythat is passed from the ROP server to the client.static StringSERVER_ROP_EVENT_BRIDGE_PROPERTIES_MAPA server-side DI container key for the Map<String, String> storing event bridge properties passed to the ROP client on bootstrap.static StringSERVER_TYPE_FACTORIES_LISTA DI container key for the List<ExtendedTypeFactory> storing default and user-provided ExtendedTypeFactories.static StringSERVER_USER_TYPES_LISTA DI container key for the List<ExtendedType> storing a user-provided ExtendedTypes.static StringSNAPSHOT_CACHE_SIZE_PROPERTYSnapshot cache max size
-
-
-
Field Detail
-
PROPERTIES_MAP
static final String PROPERTIES_MAP
A DI container key for the Map<String, String> storing properties used by built-in Cayenne service.- See Also:
- Constant Field Values
-
SERVER_ADAPTER_DETECTORS_LIST
static final String SERVER_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:
- Constant Field Values
-
SERVER_DOMAIN_FILTERS_LIST
@Deprecated static final String SERVER_DOMAIN_FILTERS_LIST
Deprecated.since 4.1 domain filters replaced with query and sync filtersA DI container key for the List<DataChannelFilter> storing DataDomain filters.
-
SERVER_DOMAIN_LISTENERS_LIST
static final String SERVER_DOMAIN_LISTENERS_LIST
A DI container key for the List<Object> storing lifecycle events listeners.- See Also:
- Constant Field Values
-
SERVER_PROJECT_LOCATIONS_LIST
static final String SERVER_PROJECT_LOCATIONS_LIST
A DI container key for the List<String> storing locations of the one of more project configuration files.- See Also:
- Constant Field Values
-
SERVER_DEFAULT_TYPES_LIST
static final String SERVER_DEFAULT_TYPES_LIST
A DI container key for the List<ExtendedType> storing default adapter-agnostic ExtendedTypes.- See Also:
- Constant Field Values
-
SERVER_USER_TYPES_LIST
static final String SERVER_USER_TYPES_LIST
A DI container key for the List<ExtendedType> storing a user-provided ExtendedTypes.- See Also:
- Constant Field Values
-
SERVER_TYPE_FACTORIES_LIST
static final String SERVER_TYPE_FACTORIES_LIST
A DI container key for the List<ExtendedTypeFactory> storing default and user-provided ExtendedTypeFactories.- See Also:
- Constant Field Values
-
SERVER_RESOURCE_LOCATOR
static final String SERVER_RESOURCE_LOCATOR
A server-side DI container key for bindingResourceLocator- See Also:
- Constant Field Values
-
SERVER_ROP_EVENT_BRIDGE_PROPERTIES_MAP
static final String SERVER_ROP_EVENT_BRIDGE_PROPERTIES_MAP
A server-side DI container key for the Map<String, String> storing event bridge properties passed to the ROP client on bootstrap.- See Also:
- Constant Field Values
-
JDBC_DRIVER_PROPERTY
static final String JDBC_DRIVER_PROPERTY
- See Also:
- Constant Field Values
-
JDBC_URL_PROPERTY
static final String JDBC_URL_PROPERTY
- See Also:
- Constant Field Values
-
JDBC_USERNAME_PROPERTY
static final String JDBC_USERNAME_PROPERTY
- See Also:
- Constant Field Values
-
JDBC_PASSWORD_PROPERTY
static final String JDBC_PASSWORD_PROPERTY
- See Also:
- Constant Field Values
-
JDBC_MIN_CONNECTIONS_PROPERTY
static final String JDBC_MIN_CONNECTIONS_PROPERTY
- See Also:
- Constant Field Values
-
JDBC_MAX_CONNECTIONS_PROPERTY
static final String JDBC_MAX_CONNECTIONS_PROPERTY
- See Also:
- Constant Field Values
-
JDBC_MAX_QUEUE_WAIT_TIME
static final String 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:
- Constant Field Values
-
JDBC_VALIDATION_QUERY_PROPERTY
static final String JDBC_VALIDATION_QUERY_PROPERTY
- Since:
- 4.0
- See Also:
- Constant Field Values
-
QUERY_CACHE_SIZE_PROPERTY
static final String 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:
- Constant Field Values
-
SERVER_DOMAIN_NAME_PROPERTY
static final String SERVER_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:
- Constant Field Values
-
SERVER_CONTEXTS_SYNC_PROPERTY
static final String SERVER_CONTEXTS_SYNC_PROPERTY
A boolean property defining whether cross-contexts synchronization is enabled. Possible values are "true" or "false".- See Also:
- Constant Field Values
-
SERVER_OBJECT_RETAIN_STRATEGY_PROPERTY
static final String SERVER_OBJECT_RETAIN_STRATEGY_PROPERTY
A String property that defines how ObjectContexts should retain cached committed objects. Possible values are "weak", "soft", "hard".- See Also:
- Constant Field Values
-
SERVER_EXTERNAL_TX_PROPERTY
static final String SERVER_EXTERNAL_TX_PROPERTY
A boolean property that defines whether runtime should use external transactions. Possible values are "true" or "false".- See Also:
- Constant Field Values
-
SERVER_ROP_EVENT_BRIDGE_FACTORY_PROPERTY
static final String SERVER_ROP_EVENT_BRIDGE_FACTORY_PROPERTY
The name of theEventBridgeFactorythat is passed from the ROP server to the client. Client would instantiate the factory to receive events from the server. Note that this property is stored inSERVER_ROP_EVENT_BRIDGE_PROPERTIES_MAP, notPROPERTIES_MAP.- See Also:
- Constant Field Values
-
SERVER_MAX_ID_QUALIFIER_SIZE_PROPERTY
static final String SERVER_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 inIncrementalFaultListor in DISJOINT_BY_ID prefetch processing. This is needed to avoid where clause size limitations and memory usage efficiency.- See Also:
- Constant Field Values
-
SERVER_MAX_QUEUE_WAIT_TIME
static final String SERVER_MAX_QUEUE_WAIT_TIME
Deprecated.since 4.0 renamed toJDBC_MAX_QUEUE_WAIT_TIME. Property name is preserved.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.- See Also:
- Constant Field Values
-
CI_PROPERTY
static final String CI_PROPERTY
Defines if database uses case-insensitive collation- See Also:
- Constant Field Values
-
QUERY_EXECUTION_TIME_LOGGING_THRESHOLD_PROPERTY
static final String 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:
- Constant Field Values
-
SNAPSHOT_CACHE_SIZE_PROPERTY
static final String SNAPSHOT_CACHE_SIZE_PROPERTY
Snapshot cache max size- Since:
- 4.0
- See Also:
ServerModule.setSnapshotCacheSize(Binder, int), Constant Field Values
-
-