com.sap.sl.sdk.authoring.connection

Interface DatabaseConnection

All Superinterfaces:

Connection, Nameable, SlResource

All Known Subinterfaces:

DataFederatorConnection, OlapConnection, RelationalConnection

public interface DatabaseConnection
extends Connection

Describes a database connection.

A DatabaseConnection is a RelationalConnection, an OlapConnection or a DataFederatorConnection.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DatabaseConnection.AuthenticationMode Provides the values used to set the parameter AUTHENTICATION_MODE.
static class	DatabaseConnection.HANAServerType Provides the SAP HANA server types used to set the parameter SAP_HANA_SERVER_TYPE.
static class	DatabaseConnection.SAPServerType Provides the SAP server types used to set the parameter SAP_SERVER_TYPE.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AUTHENTICATION_MODE The authentication mode parameter.
static java.lang.String	CONNECTIVITY_TYPE The connectivity type parameter (relational or Olap).
static java.lang.String	DATABASE The database parameter.
static java.lang.String	DATASOURCE The data source parameter.
static java.lang.String	DBMS The DBMS parameter.
static java.lang.String	JDBC_CLASS The JDBC Class parameter.
static java.lang.String	LANGUAGE The language parameter.
static java.lang.String	NETWORK_LAYER The network layer parameter.
static java.lang.String	OLAP_CUBE The cube parameter.
static java.lang.String	OLAP_PATH The path parameter.
static java.lang.String	OLAP_SERVER_NAME The server name parameter.
static java.lang.String	OLE_DB_PROVIDER The OLE DB Provider parameter.
static java.lang.String	PASSWORD The password parameter.
static java.lang.String	PROVIDER_STRING The Provider String parameter.
static java.lang.String	SAP_APPLICATION_SERVER_NAME The application server name parameter.
static java.lang.String	SAP_CLIENT_NUMBER The client number parameter.
static java.lang.String	SAP_GATEWAY_HOST_NAME The host name of gateway.
static java.lang.String	SAP_GATEWAY_SERVICE_NAME The service name of gateway.
static java.lang.String	SAP_GROUP_NAME The group name parameter.
static java.lang.String	SAP_HANA_AUTO_RECONNECT The flag to indicate the use of auto reconnect.
static java.lang.String	SAP_HANA_FETCH_SIZE The fetch size parameter.
static java.lang.String	SAP_HANA_HOST_NAME The host name parameter for single server.
static java.lang.String	SAP_HANA_INSTANCE_NUMBER The instance number parameter for single server.
static java.lang.String	SAP_HANA_SERVER_TYPE The SAP HANA server type parameter.
static java.lang.String	SAP_HANA_USE_SSL The flag to indicate the use of SSL.
static java.lang.String	SAP_MESSAGE_SERVER_NAME The message server name parameter.
static java.lang.String	SAP_PROGRAM_MAPPING The program mapping.
static java.lang.String	SAP_SAVE_LANGUAGE The save language parameter.
static java.lang.String	SAP_SERVER_TYPE The server type parameter.
static java.lang.String	SAP_SSO_USE_SNC The SSO use SNC if available parameter.
static java.lang.String	SAP_SYSTEM_ID The system ID parameter.
static java.lang.String	SAP_SYSTEM_NUMBER The system number parameter.
static java.lang.String	SAP_USE_GATEWAY The flag to indicate the use of gateway.
static java.lang.String	SAP_USE_PROGRAM_MAPPING The flag to indicate the use of program mapping.
static java.lang.String	USER_NAME The user name parameter.

Method Summary

Modifier and Type	Method and Description
ConnectionParameter	getParameter(java.lang.String name) Returns the connection parameter.
java.util.List<ConnectionParameter>	getParameters() Returns the list of parameters of a connection.

Methods inherited from interface com.sap.sl.sdk.authoring.connection.Connection

getDescription, getName, setDescription, setName

Methods inherited from interface com.sap.sl.sdk.authoring.commons.SlResource

getResourcePath

Field Detail

CONNECTIVITY_TYPE

static final java.lang.String CONNECTIVITY_TYPE

The connectivity type parameter (relational or Olap). Common to all connection types. Is read-only.

See Also:

Constant Field Values

DBMS

static final java.lang.String DBMS

The DBMS parameter. Common to all connection types. Is public. Type: String.

See Also:

Constant Field Values

NETWORK_LAYER

static final java.lang.String NETWORK_LAYER

The network layer parameter. Common to all connection types. Is public. Type: String.

See Also:

Constant Field Values

USER_NAME

static final java.lang.String USER_NAME

The user name parameter. Common to all connection types. Is private. Type: String.

See Also:

Constant Field Values

PASSWORD

static final java.lang.String PASSWORD

The password parameter. Common to all connection types. The password cannot be retrieved from the CMS. Type: String.

See Also:

Constant Field Values

AUTHENTICATION_MODE

static final java.lang.String AUTHENTICATION_MODE

The authentication mode parameter. Common to all connection types. Is public. Type is the enumerated #AuthenticationMode.

See Also:

Constant Field Values

DATABASE

static final java.lang.String DATABASE

The database parameter. Type: String.

See Also:

Constant Field Values

DATASOURCE

static final java.lang.String DATASOURCE

The data source parameter. Type: String.

See Also:

Constant Field Values

JDBC_CLASS

static final java.lang.String JDBC_CLASS

The JDBC Class parameter. Type: String.

See Also:

Constant Field Values

OLE_DB_PROVIDER

static final java.lang.String OLE_DB_PROVIDER

The OLE DB Provider parameter. Type: String.

See Also:

Constant Field Values

PROVIDER_STRING

static final java.lang.String PROVIDER_STRING

The Provider String parameter. Type: String.

See Also:

Constant Field Values

LANGUAGE

static final java.lang.String LANGUAGE

The language parameter. Is used for SAP connections and OLAP connections. Type: String.

See Also:

Constant Field Values

OLAP_SERVER_NAME

static final java.lang.String OLAP_SERVER_NAME

The server name parameter. Is only used for OLAP connections. Type: String.

See Also:

Constant Field Values

OLAP_PATH

static final java.lang.String OLAP_PATH

The path parameter. Is only used for OLAP connections. Type: String.

See Also:

Constant Field Values

OLAP_CUBE

static final java.lang.String OLAP_CUBE

The cube parameter. Is only used for OLAP connections. Type: String.

See Also:

Constant Field Values

SAP_CLIENT_NUMBER

static final java.lang.String SAP_CLIENT_NUMBER

The client number parameter. Is used for SAP connections. Type: String.

See Also:

Constant Field Values

SAP_SYSTEM_ID

static final java.lang.String SAP_SYSTEM_ID

The system ID parameter. Is used for SAP connections. Type: String.

See Also:

Constant Field Values

SAP_SAVE_LANGUAGE

static final java.lang.String SAP_SAVE_LANGUAGE

The save language parameter. Is used for SAP connections. Type: Boolean (only "true" or "false").

See Also:

Constant Field Values

SAP_SSO_USE_SNC

static final java.lang.String SAP_SSO_USE_SNC

The SSO use SNC if available parameter. Is used for SAP connections. Type: Boolean (only "true" or "false").

See Also:

Constant Field Values

SAP_SERVER_TYPE

static final java.lang.String SAP_SERVER_TYPE

The server type parameter. Is used for SAP connections. Type is the enumerated #SAPServerType.

See Also:

Constant Field Values

SAP_APPLICATION_SERVER_NAME

static final java.lang.String SAP_APPLICATION_SERVER_NAME

The application server name parameter. Is used for SAP connections. Type: String.

See Also:

Constant Field Values

SAP_SYSTEM_NUMBER

static final java.lang.String SAP_SYSTEM_NUMBER

The system number parameter. Is used for SAP connections. Type: String.

See Also:

Constant Field Values

SAP_MESSAGE_SERVER_NAME

static final java.lang.String SAP_MESSAGE_SERVER_NAME

The message server name parameter. Is used for SAP connections. Type: String.

See Also:

Constant Field Values

SAP_GROUP_NAME

static final java.lang.String SAP_GROUP_NAME

The group name parameter. Is used for SAP connections with a Message Server. Type: String.

See Also:

Constant Field Values

SAP_USE_PROGRAM_MAPPING

static final java.lang.String SAP_USE_PROGRAM_MAPPING

The flag to indicate the use of program mapping. Is used for SAP BW connections. Type: Boolean.

See Also:

Constant Field Values

SAP_PROGRAM_MAPPING

static final java.lang.String SAP_PROGRAM_MAPPING

The program mapping. Is used for SAP BW connections. Type: String.

See Also:

Constant Field Values

SAP_USE_GATEWAY

static final java.lang.String SAP_USE_GATEWAY

The flag to indicate the use of gateway. Is used for SAP BW connections. Type: Boolean.

See Also:

Constant Field Values

SAP_GATEWAY_HOST_NAME

static final java.lang.String SAP_GATEWAY_HOST_NAME

The host name of gateway. Is used for SAP BW connections. Type: String.

See Also:

Constant Field Values

SAP_GATEWAY_SERVICE_NAME

static final java.lang.String SAP_GATEWAY_SERVICE_NAME

The service name of gateway. Is used for SAP BW connections. Type: String.

See Also:

Constant Field Values

SAP_HANA_SERVER_TYPE

static final java.lang.String SAP_HANA_SERVER_TYPE

The SAP HANA server type parameter. Is used for SAP HANA relational and OLAP connections. Type is the enumerated #HANAServerType.

See Also:

Constant Field Values

SAP_HANA_HOST_NAME

static final java.lang.String SAP_HANA_HOST_NAME

The host name parameter for single server. Is used for SAP HANA relational and OLAP connections. Type: String.

See Also:

Constant Field Values

SAP_HANA_INSTANCE_NUMBER

static final java.lang.String SAP_HANA_INSTANCE_NUMBER

The instance number parameter for single server. Is used for SAP HANA relational and OLAP connections. Type: String.

See Also:

Constant Field Values

SAP_HANA_USE_SSL

static final java.lang.String SAP_HANA_USE_SSL

The flag to indicate the use of SSL. Is used for SAP HANA relational and OLAP connections. Type: Boolean.

See Also:

Constant Field Values

SAP_HANA_AUTO_RECONNECT

static final java.lang.String SAP_HANA_AUTO_RECONNECT

The flag to indicate the use of auto reconnect. Is used for SAP HANA OLAP connections. Type: Boolean.

See Also:

Constant Field Values

SAP_HANA_FETCH_SIZE

static final java.lang.String SAP_HANA_FETCH_SIZE

The fetch size parameter. Is used for SAP HANA OLAP connections. Type: Integer.

See Also:

Constant Field Values

Method Detail

getParameter

ConnectionParameter getParameter(java.lang.String name)

Returns the connection parameter.

Parameters:

name - The parameter name

Returns:

A ConnectionParameter object

getParameters

java.util.List<ConnectionParameter> getParameters()

Returns the list of parameters of a connection.

Returns:

A list of ConnectionParameter objects