com.businessobjects.connectionserver.datasources.ddk
Interface Context

public interface Context

This interface manages connection and driver-specific configuration information. This interface provides the custom driver with the following functionality:

• Manage all credential information required to establish a connection.
• Manage all configuration information for a specific connection.
• Manage all error handling to be propagated to the upper layers.
• Retrieve information from the driver-specific configuration files.

The custom driver must maintain this context information so that it can:

• Propagate errors to upper layers
• Navigate through connection and driver-specific configuration information

Author:

Business Objects

Method Summary

DriverConfiguration	getConfiguration() Returns the connection's configuration information as specified in the driver's .sbo file.
java.util.Map	getCredentials() Returns the connection's credential information.
java.lang.String	getDataBase() Returns the name of the datasource, for example the database, configured when the connection was created.
ErrorManager	getErrors() Returns the ErrorManager associated with a connection.
PropertySet	getProperties() Returns the configuration properties for a connection.

Method Detail

getCredentials

java.util.Map getCredentials()

Returns the connection's credential information.

Returns a Java map containing the credentials information used to establish a connection to the data source, for example user and password details. This information is normally configured as part of the connection creation process. In the driver's .cod file used by the New Connection wizard, these are the parameters with the CREDENTIALS category.

Returns:

A Java map containing the credentials information used to establish the connection.

getDataBase

java.lang.String getDataBase()

Returns the name of the datasource, for example the database, configured when the connection was created.

Returns:

A non-null string representing name of the datasource.

getErrors

ErrorManager getErrors()

Returns the ErrorManager associated with a connection.

The ErrorManager allows custom drivers to propagate driver-specific errors to the upper layers. For example, if a custom driver x encounters an exception during the parsing of a query, the exception can be caught and rethrown as a CSException.

Returns:

An ErrorManager

getConfiguration

DriverConfiguration getConfiguration()

Returns the connection's configuration information as specified in the driver's .sbo file.

Returns:

The driver configuration information.

getProperties

PropertySet getProperties()

Returns the configuration properties for a connection.

Returns:

properties The configuration properties for a connection.