EclipseLink 1.1.4, build 'v20100812-r7860' API Reference

org.eclipse.persistence.eis
Class EISLogin

java.lang.Object
  extended by org.eclipse.persistence.sessions.DatasourceLogin
      extended by org.eclipse.persistence.eis.EISLogin
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, Login

public class EISLogin
extends DatasourceLogin

An EISLogin defines connection information and datasource properties. There are three ways to connect to an EIS datasource through EclipseLink EIS:

A EISConnectionSpec must be provided to define how to connect to the EIS adapter.

The EIS platform can be used to provide datasource/driver specific behavior such as InteractionSpec and Record conversion.

See Also:
EISConnectionSpec, Serialized Form
Author:
James
Since:
OracleAS TopLink 10g (10.0.3)

Field Summary
 
Fields inherited from class org.eclipse.persistence.sessions.DatasourceLogin
cacheTransactionIsolation, CONCURRENT_READ_WRITE, connector, platform, properties, SYNCHRONIZED_READ_ON_WRITE, SYNCHRONIZED_WRITE, SYNCRONIZED_OBJECT_LEVEL_READ_WRITE, SYNCRONIZED_OBJECT_LEVEL_READ_WRITE_DATABASE, usesExternalConnectionPooling, usesExternalTransactionController, versionString
 
Constructor Summary
EISLogin()
          Default constructor.
EISLogin(org.eclipse.persistence.internal.databaseaccess.Platform platform)
          Constructor.
 
Method Summary
 org.eclipse.persistence.internal.databaseaccess.Accessor buildAccessor()
          Build and return the EIS accessorr.
 void configureConnectionSpec(javax.resource.cci.ConnectionFactory connectionFactory)
          PUBLIC: Configure the login to connect through a non-managed connection factory and the default getConnection().
 void configureConnectionSpec(javax.resource.cci.ConnectionFactory connectionFactory, javax.resource.cci.ConnectionSpec connectionSpec)
          PUBLIC: Configure the login to connect through a non-managed connection factory and adapter connection spec.
 void configureConnectionSpec(java.lang.String jndiName)
          PUBLIC: Configure the login to connect through a JDNI managed connection factory and the default getConnection().
 void configureConnectionSpec(java.lang.String jndiName, javax.resource.cci.ConnectionSpec connectionSpec)
          PUBLIC: Configure the login to connect through a JDNI managed connection factory and adapter connection spec.
 java.lang.Object connectToDatasource(org.eclipse.persistence.internal.databaseaccess.Accessor accessor, Session session)
          Connect to the EIS adapter and return the Connection.
 java.lang.String getConnectionFactoryURL()
          PUBLIC: Return the JNDI URL for the managed connection factory for the JCA adapter connecting to.
 EISConnectionSpec getConnectionSpec()
          Return the connector.
 void setConnectionFactoryURL(java.lang.String url)
          PUBLIC: Set the JNDI URL for the managed connection factory for the JCA adapter connecting to.
 void setConnectionSpec(EISConnectionSpec connectionSpec)
          PUBLIC: Set the EclipseLink connection spec.
 void setPassword(java.lang.String password)
          PUBLIC: Set the password.
 
Methods inherited from class org.eclipse.persistence.sessions.DatasourceLogin
addSequence, clone, dontUseExternalConnectionPooling, dontUseExternalTransactionController, getCacheTransactionIsolation, getConnector, getDatasourcePlatform, getDefaultSequence, getDefaultSequenceToWrite, getPassword, getPlatform, getPlatformClassName, getProperties, getProperty, getSecurableObjectHolder, getSequence, getSequences, getSequencesToWrite, getTableQualifier, getUserName, getVersion, isConnectionHealthValidatedOnError, removeAllSequences, removeProperty, removeSequence, setCacheTransactionIsolation, setConnector, setDatasourcePlatform, setDefaultNullValue, setDefaultSequence, setEncryptedPassword, setEncryptionClassName, setPlatform, setPlatformClassName, setPlatformClassName, setProperties, setProperty, setSequences, setTableQualifier, setTimestampQuery, setUserName, setUsesExternalConnectionPooling, setUsesExternalTransactionController, shouldAllowConcurrentReadWrite, shouldSynchronizedReadOnWrite, shouldSynchronizeObjectLevelReadWrite, shouldSynchronizeObjectLevelReadWriteDatabase, shouldSynchronizeWrites, shouldUseExternalConnectionPooling, shouldUseExternalTransactionController, toString, useExternalConnectionPooling, useExternalTransactionController, usePlatform
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

EISLogin

public EISLogin()
Default constructor.


EISLogin

public EISLogin(org.eclipse.persistence.internal.databaseaccess.Platform platform)
Constructor.

Method Detail

buildAccessor

public org.eclipse.persistence.internal.databaseaccess.Accessor buildAccessor()
Build and return the EIS accessorr.


connectToDatasource

public java.lang.Object connectToDatasource(org.eclipse.persistence.internal.databaseaccess.Accessor accessor,
                                            Session session)
Connect to the EIS adapter and return the Connection.

Specified by:
connectToDatasource in interface Login
Overrides:
connectToDatasource in class DatasourceLogin

setPassword

public void setPassword(java.lang.String password)
PUBLIC: Set the password.

Specified by:
setPassword in interface Login
Overrides:
setPassword in class DatasourceLogin

getConnectionFactoryURL

public java.lang.String getConnectionFactoryURL()
PUBLIC: Return the JNDI URL for the managed connection factory for the JCA adapter connecting to.


setConnectionFactoryURL

public void setConnectionFactoryURL(java.lang.String url)
PUBLIC: Set the JNDI URL for the managed connection factory for the JCA adapter connecting to.


getConnectionSpec

public EISConnectionSpec getConnectionSpec()
Return the connector. The connector defines how the connection is created.


setConnectionSpec

public void setConnectionSpec(EISConnectionSpec connectionSpec)
PUBLIC: Set the EclipseLink connection spec. The connection spec defines how to connect to the EIS adapter.


configureConnectionSpec

public void configureConnectionSpec(java.lang.String jndiName)
PUBLIC: Configure the login to connect through a JDNI managed connection factory and the default getConnection().


configureConnectionSpec

public void configureConnectionSpec(javax.resource.cci.ConnectionFactory connectionFactory)
PUBLIC: Configure the login to connect through a non-managed connection factory and the default getConnection().


configureConnectionSpec

public void configureConnectionSpec(java.lang.String jndiName,
                                    javax.resource.cci.ConnectionSpec connectionSpec)
PUBLIC: Configure the login to connect through a JDNI managed connection factory and adapter connection spec.


configureConnectionSpec

public void configureConnectionSpec(javax.resource.cci.ConnectionFactory connectionFactory,
                                    javax.resource.cci.ConnectionSpec connectionSpec)
PUBLIC: Configure the login to connect through a non-managed connection factory and adapter connection spec.


EclipseLink 1.1.4, build 'v20100812-r7860' API Reference