ro.sync.exml.workspace.api.options
Interface DataSourceConnectionInfo

@API(type=NOT_EXTENDABLE,
     src=PUBLIC)
public interface DataSourceConnectionInfo

Provides properties values for a Data source.

Since:

14.1

*********************************
EXPERIMENTAL - Subject to change
********************************

Please note that this API is not marked as final and it can change in one of the next versions of the application. If you have suggestions, comments about it, please let us know.

Field Summary

static java.lang.String	CONNECTION_NAME Property ID for the unique name of the connection.
static java.lang.String	DRIVER_NAME Property ID for the driver name used to access the database.
static java.lang.String	HOST_NAME Property ID for the host name to connect to.
static java.lang.String	INITIAL_DATABASE Property ID for the initial database from server to connect to.
static java.lang.String	PORT Property ID for the port used to connect to host.
static java.lang.String	URL Property ID for the URL used to connect to the database.
static java.lang.String	WEBDAV_URL Property ID for the WEBDAV URL.

Method Summary

java.lang.Object

getProperty(java.lang.String propertyId) Used to return properties values for a data source connection.

Field Detail

DRIVER_NAME

static final java.lang.String DRIVER_NAME

Property ID for the driver name used to access the database. It can not be null.

See Also:

Constant Field Values

HOST_NAME

static final java.lang.String HOST_NAME

Property ID for the host name to connect to. For relational databases it can be null.

See Also:

Constant Field Values

INITIAL_DATABASE

static final java.lang.String INITIAL_DATABASE

Property ID for the initial database from server to connect to. It can be null.

See Also:

Constant Field Values

PORT

static final java.lang.String PORT

Property ID for the port used to connect to host. For relational databases can be included into the URL.

See Also:

Constant Field Values

CONNECTION_NAME

static final java.lang.String CONNECTION_NAME

Property ID for the unique name of the connection.

See Also:

Constant Field Values

URL

static final java.lang.String URL

Property ID for the URL used to connect to the database. It can be null.

See Also:

Constant Field Values

WEBDAV_URL

static final java.lang.String WEBDAV_URL

Property ID for the WEBDAV URL. Some databases can be accessed using a WEBDAV URL. It can be null.

See Also:

Constant Field Values

Method Detail

getProperty

java.lang.Object getProperty(java.lang.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.