Interface RuntimeProperties

All Known Implementing Classes:
DefaultRuntimeProperties
public interface RuntimeProperties
Represents a properties map for a given CayenneRuntime.
Since:
3.1

  • Field Details

    • JDBC_DRIVER_PROPERTY

      static final String JDBC_DRIVER_PROPERTY
      See Also:

    • JDBC_URL_PROPERTY

      static final String JDBC_URL_PROPERTY
      See Also:

    • JDBC_USERNAME_PROPERTY

      static final String JDBC_USERNAME_PROPERTY
      See Also:

    • JDBC_PASSWORD_PROPERTY

      static final String JDBC_PASSWORD_PROPERTY
      See Also:

    • JDBC_MIN_CONNECTIONS_PROPERTY

      static final String JDBC_MIN_CONNECTIONS_PROPERTY
      See Also:

    • JDBC_MAX_CONNECTIONS_PROPERTY

      static final String JDBC_MAX_CONNECTIONS_PROPERTY
      See Also:

    • 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:

    • JDBC_VALIDATION_QUERY_PROPERTY

      static final String JDBC_VALIDATION_QUERY_PROPERTY
      Since:
      4.0
      See Also:

    • 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:

    • DOMAIN_NAME_PROPERTY

      static final String 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:

    • CONTEXTS_SYNC_PROPERTY

      static final String CONTEXTS_SYNC_PROPERTY
      A boolean property defining whether cross-contexts synchronization is enabled. Possible values are "true" or "false".
      See Also:

    • OBJECT_RETAIN_STRATEGY_PROPERTY

      static final String OBJECT_RETAIN_STRATEGY_PROPERTY
      A String property that defines how ObjectContexts should retain cached committed objects. Possible values are "weak", "soft", "hard".
      See Also:

    • EXTERNAL_TX_PROPERTY

      static final String EXTERNAL_TX_PROPERTY
      A boolean property that defines whether runtime should use external transactions. Possible values are "true" or "false".
      See Also:

    • MAX_ID_QUALIFIER_SIZE_PROPERTY

      static final String 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 in IncrementalFaultList or in DISJOINT_BY_ID prefetch processing. This is needed to avoid where clause size limitations and memory usage efficiency.
      See Also:

    • CI_PROPERTY

      static final String CI_PROPERTY
      Defines if database uses case-insensitive collation
      See Also:

    • JDBC_LOG_BATCH_ROW_THRESHOLD_PROPERTY

      static final String JDBC_LOG_BATCH_ROW_THRESHOLD_PROPERTY
      An integer property defining the maximum number of batch rows whose bindings are logged in full before the compact SQL logger truncates them to "first row .. elided count .. last row". Default is 20.
      Since:
      5.0
      See Also:

    • SNAPSHOT_CACHE_SIZE_PROPERTY

      static final String SNAPSHOT_CACHE_SIZE_PROPERTY
      Snapshot cache max size
      Since:
      4.0
      See Also:

  • Method Details

    • get

      String get(String key)
      Returns a String property value for a given key.

    • get

      String get(String key, String defaultValue)
      Returns a String property value for a given key or a default value if a value is not present in properties or is null.
      Since:
      4.0

    • getInt

      int getInt(String key, int defaultValue)

    • getBoolean

      boolean getBoolean(String key, boolean defaultValue)

    • toMap

      Map<String,String> toMap()
      Returns a snapshot of the properties as a map, with the same key resolution rules as get(String).
      Since:
      5.0