org.eclipse.datatools.enablement.oda.ws.impl
Class Driver

java.lang.Object
  org.eclipse.datatools.enablement.oda.ws.impl.Driver

All Implemented Interfaces:

IDriver

public class Driver
extends java.lang.Object
implements IDriver

Implementation class of IDriver for an ODA runtime driver.

Constructor Summary

Driver()

Method Summary

IConnection	getConnection(java.lang.String dataSourceType) Returns an IConnection object that can then be used to establish a runtime connection to the underlying data source with the given unique id.
int	getMaxConnections() Returns the maximum number of concurrent connections that the driver can support.
void	setAppContext(java.lang.Object context) Sets the driver context passed through from an application.
void	setLogConfiguration(LogConfiguration logConfig) An optional method to set the trace logging configuration of the ODA runtime driver for the given type of data source and its runtime connection(s).

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Driver

public Driver()

Method Detail

getConnection

public IConnection getConnection(java.lang.String dataSourceType)
                          throws OdaException

Description copied from interface: IDriver

Returns an IConnection object that can then be used to establish a runtime connection to the underlying data source with the given unique id.

Specified by:

getConnection in interface IDriver

Parameters:

dataSourceType - The id of a type of data source supported by this IDriver. This matches the data source element id defined in the data source driver's configuration file. A null or empty String will use the default data source type supported by this IDriver.

Returns:

an IConnection object

Throws:

OdaException - if data source error occurs.

See Also:

IConnection

setLogConfiguration

public void setLogConfiguration(LogConfiguration logConfig)
                         throws OdaException

Description copied from interface: IDriver

An optional method to set the trace logging configuration of the ODA runtime driver for the given type of data source and its runtime connection(s).

Specified by:

setLogConfiguration in interface IDriver

Parameters:

logConfig - The trace logging configuration.

Throws:

OdaException - if ODA runtime driver error occurs.

getMaxConnections

public int getMaxConnections()
                      throws OdaException

Description copied from interface: IDriver

Returns the maximum number of concurrent connections that the driver can support.

Specified by:

getMaxConnections in interface IDriver

Returns:

the maximum number of any type of connections that can be open concurrently, or 0 if there is no limit or the limit is unknown.

Throws:

OdaException - if driver error occurs.

setAppContext

public void setAppContext(java.lang.Object context)
                   throws OdaException

Description copied from interface: IDriver

Sets the driver context passed through from an application. Its handling is specific to individual driver implementation. The context argument could be null. The method may be called by an ODA consumer application with a null argument, i.e. passing a null context object to this instance, only if a non-null context was previously passed through to the same instance.
Note: This method should be called before getConnection( String ).
An optional method. If any part of the context is not recognized by the driver, it should simply ignore, and not throw an exception.

Specified by:

setAppContext in interface IDriver

Parameters:

context - Application context object of this instance.

Throws:

OdaException - if data source error occurs