oracle.toplink.jndi
Class JNDIConnector

java.lang.Object
  oracle.toplink.jndi.JNDIConnector

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, Connector

Direct Known Subclasses:

OracleJDBC10_1_0_2ProxyConnector, OracleOCIProxyConnector

public class JNDIConnector
extends java.lang.Object
implements Connector

Specifies the J2EE DataSource lookup options. This connector is normally used with a login in a J2EE environment to connect to a server's connection pool defined by the DataSource name. The JNDI name that the DataSource is registered under must be specified, this must include any required prefix such as "java:comp/env/", (unless a DataSource object is given). A Context is only required if not running on the server, otheriwse default to a new InitialContext().

Since:

TOPLink/Java 2.1

See Also:

Serialized Form

Field Summary

static int	COMPOSITE_NAME_LOOKUP
static int	COMPOUND_NAME_LOOKUP
static int	STRING_LOOKUP

Constructor Summary

JNDIConnector()
Construct a Connector with no settings.

JNDIConnector(javax.naming.Context context, java.lang.String name)
Construct a Connector with the datasource name.

JNDIConnector(javax.sql.DataSource dataSource)
Construct a Connector with the datasource object.

JNDIConnector(java.lang.String name)
Construct a Connector with the datasource name.

Method Summary

java.lang.String	getConnectionDetails() Provide the details of my connection information.
javax.naming.Context	getContext() Return the JNDI Context that can supplied the named DataSource.
javax.sql.DataSource	getDataSource() Return the javax.sql.DataSource.
int	getLookupType()
java.lang.String	getName() Return the name of the DataSource within the JNDI Context.
void	setContext(javax.naming.Context context) Set the JNDI Context that can supply the named DataSource.
void	setDataSource(javax.sql.DataSource dataSource) Set the javax.sql.DataSource.
void	setLookupType(int lookupType)
void	setName(java.lang.String name) Set the name of the DataSource within the JNDI Context.
java.lang.String	toString() Print data source info.

Methods inherited from class java.lang.Object

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

Field Detail

STRING_LOOKUP

public static final int STRING_LOOKUP

See Also:

Constant Field Values

COMPOSITE_NAME_LOOKUP

public static final int COMPOSITE_NAME_LOOKUP

See Also:

Constant Field Values

COMPOUND_NAME_LOOKUP

public static final int COMPOUND_NAME_LOOKUP

See Also:

Constant Field Values

Constructor Detail

JNDIConnector

public JNDIConnector()

Construct a Connector with no settings. The datasource name will still need to be set.

JNDIConnector

public JNDIConnector(javax.naming.Context context,
                     java.lang.String name)
              throws ValidationException

Construct a Connector with the datasource name.

Throws:

ValidationException

JNDIConnector

public JNDIConnector(java.lang.String name)

Construct a Connector with the datasource name.

JNDIConnector

public JNDIConnector(javax.sql.DataSource dataSource)

Construct a Connector with the datasource object.

Method Detail

getContext

public javax.naming.Context getContext()

Return the JNDI Context that can supplied the named DataSource.

getDataSource

public javax.sql.DataSource getDataSource()

Return the javax.sql.DataSource.

getName

public java.lang.String getName()

Return the name of the DataSource within the JNDI Context.

getConnectionDetails

public java.lang.String getConnectionDetails()

Provide the details of my connection information. This is primarily for JMX runtime services.

Specified by:

getConnectionDetails in interface Connector

Returns:

java.lang.String

setContext

public void setContext(javax.naming.Context context)

Set the JNDI Context that can supply the named DataSource.

setDataSource

public void setDataSource(javax.sql.DataSource dataSource)

Set the javax.sql.DataSource.

setName

public void setName(java.lang.String name)
             throws ValidationException

Set the name of the DataSource within the JNDI Context.

Throws:

ValidationException

setLookupType

public void setLookupType(int lookupType)

getLookupType

public int getLookupType()

toString

public java.lang.String toString()

Print data source info.

Overrides:

toString in class java.lang.Object