java.lang.Object
- org.eclipse.persistence.sessions.JNDIConnector

All Implemented Interfaces:

Serializable, Cloneable, Connector

Direct Known Subclasses:

OracleOCIProxyConnector
```
public class JNDIConnector
extends 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, otherwise default to a new InitialContext().

See Also:

Serialized Form

Author:

Big Country

Since:

TOPLink/Java 2.1

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`COMPOSITE_NAME_LOOKUP`
`static int`	`COMPOUND_NAME_LOOKUP`
`protected Context`	`context`
`protected DataSource`	`dataSource`
`protected boolean`	`isCallbackRegistered`
`protected int`	`lookupType`	Deprecated.
`protected String`	`name`
`static int`	`STRING_LOOKUP`
`static int`	`UNDEFINED_LOOKUP`

Constructor Summary

Constructors
Constructor	Description
`JNDIConnector()`	PUBLIC: Construct a Connector with no settings.
`JNDIConnector(String name)`	PUBLIC: Construct a Connector with the datasource name.
`JNDIConnector(Context context, String name)`	PUBLIC: Construct a Connector with the datasource name.
`JNDIConnector(DataSource dataSource)`	PUBLIC: Construct a Connector with the datasource object.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`Object`	`clone()`	INTERNAL: Clone the connector.
`Connection`	`connect(Properties properties, Session session)`	INTERNAL: Connect with the specified properties and return the Connection.
`String`	`getConnectionDetails()`	PUBLIC: Provide the details of my connection information.
`Context`	`getContext()`	PUBLIC: Return the JNDI Context that can supplied the named DataSource.
`DataSource`	`getDataSource()`	PUBLIC: Return the javax.sql.DataSource.
`int`	`getLookupType()`	Deprecated. As of 2.6.0, replaced by configuration provided by `ServerPlatform.getJNDIConnectorLookupType()`
`String`	`getName()`	PUBLIC: Return the name of the DataSource within the JNDI Context.
`void`	`setContext(Context context)`	PUBLIC: Set the JNDI Context that can supply the named DataSource.
`void`	`setDataSource(DataSource dataSource)`	PUBLIC: Set the javax.sql.DataSource.
`void`	`setLookupType(int lookupType)`	Deprecated. As of 2.6.0, replaced by configuration provided by `ServerPlatform.getJNDIConnectorLookupType()`
`void`	`setName(String name)`	PUBLIC: Set the name of the DataSource within the JNDI Context.
`String`	`toString()`	PUBLIC: Print data source info.
`void`	`toString(PrintWriter writer)`	INTERNAL: Print something useful on the log.

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - dataSource
```
protected DataSource dataSource
```
  - context
```
protected Context context
```
  - name
```
protected String name
```
  - isCallbackRegistered
```
protected boolean isCallbackRegistered
```
  - UNDEFINED_LOOKUP
```
public static final int UNDEFINED_LOOKUP
```
    See Also:
    
    Constant Field Values
  - 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
  - lookupType
```
@Deprecated
protected int lookupType
```
    Deprecated.
- Constructor Detail
  - JNDIConnector
```
public JNDIConnector()
```
    PUBLIC: Construct a Connector with no settings. The datasource name will still need to be set.
  - JNDIConnector
```
public JNDIConnector(Context context,
                     String name)
              throws ValidationException
```
    PUBLIC: Construct a Connector with the datasource name.
    
    Throws:
    
    ValidationException
  - JNDIConnector
```
public JNDIConnector(String name)
```
    PUBLIC: Construct a Connector with the datasource name.
  - JNDIConnector
```
public JNDIConnector(DataSource dataSource)
```
    PUBLIC: Construct a Connector with the datasource object.
- Method Detail
  - clone
```
public Object clone()
```
    INTERNAL: Clone the connector.
    
    Specified by:
    
    clone in interface Connector
    
    Overrides:
    
    clone in class Object
  - connect
```
public Connection connect(Properties properties,
                          Session session)
                   throws DatabaseException,
                          ValidationException
```
    INTERNAL: Connect with the specified properties and return the Connection.
    
    Specified by:
    
    connect in interface Connector
    
    Returns:
    
    java.sql.Connection
    
    Throws:
    
    DatabaseException
    
    ValidationException
  - getContext
```
public Context getContext()
```
    PUBLIC: Return the JNDI Context that can supplied the named DataSource.
  - getDataSource
```
public DataSource getDataSource()
```
    PUBLIC: Return the javax.sql.DataSource.
  - getName
```
public String getName()
```
    PUBLIC: Return the name of the DataSource within the JNDI Context.
  - getConnectionDetails
```
public String getConnectionDetails()
```
    PUBLIC: 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(Context context)
```
    PUBLIC: Set the JNDI Context that can supply the named DataSource.
  - setDataSource
```
public void setDataSource(DataSource dataSource)
```
    PUBLIC: Set the javax.sql.DataSource.
  - setName
```
public void setName(String name)
             throws ValidationException
```
    PUBLIC: Set the name of the DataSource within the JNDI Context.
    
    Throws:
    
    ValidationException
  - setLookupType
```
@Deprecated
public void setLookupType(int lookupType)
```
    Deprecated.
    As of 2.6.0, replaced by configuration provided by ServerPlatform.getJNDIConnectorLookupType()
  - getLookupType
```
@Deprecated
public int getLookupType()
```
    Deprecated.
    As of 2.6.0, replaced by configuration provided by ServerPlatform.getJNDIConnectorLookupType()
  - toString
```
public String toString()
```
    PUBLIC: Print data source info.
    
    Overrides:
    
    toString in class Object
  - toString
```
public void toString(PrintWriter writer)
```
    INTERNAL: Print something useful on the log.
    
    Specified by:
    
    toString in interface Connector

Class JNDIConnector

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

dataSource

context

name

isCallbackRegistered

UNDEFINED_LOOKUP

STRING_LOOKUP

COMPOSITE_NAME_LOOKUP

COMPOUND_NAME_LOOKUP

lookupType

Constructor Detail

JNDIConnector

JNDIConnector

JNDIConnector

JNDIConnector

Method Detail

clone

connect

getContext

getDataSource

getName

getConnectionDetails

setContext

setDataSource

setName

setLookupType

getLookupType

toString

toString