Package org.odpi.openmetadata.adapters.connectors.resource.jdbc.controls

Enum Class JDBCConfigurationProperty

java.lang.Object
java.lang.Enum<JDBCConfigurationProperty>
org.odpi.openmetadata.adapters.connectors.resource.jdbc.controls.JDBCConfigurationProperty
All Implemented Interfaces:
Serializable, Comparable<JDBCConfigurationProperty>, Constable
public enum JDBCConfigurationProperty extends Enum<JDBCConfigurationProperty>
PostgresConfigurationProperty provides some standard definitions for configuration properties used to pass properties to connectors when they run. Using standard names for request parameters wherever possible helps to simplify the integration of governance services.

  • Enum Constant Details

    • DATABASE_URL

      public static final JDBCConfigurationProperty DATABASE_URL
      Connection string for the database where the schema is located. This should set the current schema to your chosen schema.

    • DATABASE_NAME

      public static final JDBCConfigurationProperty DATABASE_NAME
      Provides a name to use in messages about the database. If it is not set then the connection URL string is used.

    • DATABASE_SCHEMA

      public static final JDBCConfigurationProperty DATABASE_SCHEMA
      The name of the database schema used to store the data. This should match the schema set up in the database URL.

    • SECRETS_STORE

      public static final JDBCConfigurationProperty SECRETS_STORE
      The file name of the secrets store containing the log on credentials to access the database.

    • SECRETS_COLLECTION_NAME

      public static final JDBCConfigurationProperty SECRETS_COLLECTION_NAME
      The name of the secrets collection within the secrets store to use for login credentials.

    • JDBC_DRIVER_MANAGER_CLASS_NAME

      public static final JDBCConfigurationProperty JDBC_DRIVER_MANAGER_CLASS_NAME
      An optional configuration property that causes the named class to be loaded and registered as a driver. This property only needs to be defined if the connector is experiencing exceptions related to a missing DriverManager class for the database URL.

    • JDBC_CONNECTION_TIMEOUT

      public static final JDBCConfigurationProperty JDBC_CONNECTION_TIMEOUT
      Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. The default value is 0 which means use the system default timeout, if any; otherwise it means no timeout.

  • Field Details

    • name

      public final String name

    • description

      public final String description

    • dataType

      public final String dataType

    • example

      public final String example

  • Method Details

    • values

      public static JDBCConfigurationProperty[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static JDBCConfigurationProperty valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • getName

      public String getName()
      Return the name of the request parameter.
      Returns:
      string name

    • getDescription

      public String getDescription()
      Return the description of the request parameter.
      Returns:
      text

    • getDataType

      public String getDataType()
      Return the data type for the request parameter.
      Returns:
      data type name

    • getExample

      public String getExample()
      Return an example of the request parameter to help users understand how to set it up.
      Returns:
      example

    • getRecognizedConfigurationProperties

      public static List<String> getRecognizedConfigurationProperties()
      Get recognizedConfigurationProperties for the connector.
      Returns:
      list of property names

    • getConfigurationPropertyTypes

      public static List<ConfigurationPropertyType> getConfigurationPropertyTypes()
      Retrieve all the defined configuration properties
      Returns:
      list

    • getConfigurationPropertyType

      public ConfigurationPropertyType getConfigurationPropertyType()
      Return a summary of this enum to use in a service provider.
      Returns:
      request parameter type

    • toString

      public String toString()
      Output of this enum class and main value.
      Overrides:
      toString in class Enum<JDBCConfigurationProperty>
      Returns:
      string showing enum value