Interface DataSourceConnectionInfo


@API(type=NOT_EXTENDABLE, src=PUBLIC) public interface DataSourceConnectionInfo
Provides properties values for a Data source.
Since:
14.1
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Property ID for the unique name of the connection.
    static final String
    Property ID for the driver name used to access the database.
    static final String
    Property ID for the host name to connect to.
    static final String
    Property ID for the initial database from server to connect to.
    static final String
    Property ID for the port used to connect to host.
    static final String
    Property ID for the URL used to connect to the database.
    static final String
    Property ID for the WEBDAV URL.
  • Method Summary

    Modifier and Type
    Method
    Description
    getProperty(String propertyId)
    Used to return properties values for a data source connection.
  • Field Details

    • DRIVER_NAME

      static final String DRIVER_NAME
      Property ID for the driver name used to access the database. It can not be null.
      See Also:
    • HOST_NAME

      static final String HOST_NAME
      Property ID for the host name to connect to. For relational databases it can be null.
      See Also:
    • INITIAL_DATABASE

      static final String INITIAL_DATABASE
      Property ID for the initial database from server to connect to. It can be null.
      See Also:
    • PORT

      static final String PORT
      Property ID for the port used to connect to host. For relational databases can be included into the URL.
      See Also:
    • CONNECTION_NAME

      static final String CONNECTION_NAME
      Property ID for the unique name of the connection.
      See Also:
    • URL

      static final String URL
      Property ID for the URL used to connect to the database. It can be null.
      See Also:
    • WEBDAV_URL

      static final String WEBDAV_URL
      Property ID for the WEBDAV URL. Some databases can be accessed using a WEBDAV URL. It can be null.
      See Also:
  • Method Details

    • getProperty

      Object getProperty(String propertyId)
      Used to return properties values for a data source connection.
      Parameters:
      propertyId - The property identifier.
      Returns:
      The value of the property identified by the propertyId. The propertyId can be one of the Id constants defined in the DataSourceConnectionInfo.