Top Description Fields Constructors Methods
org.eclipse.persistence.eis

public Class EISConnectionSpec

extends Object
implements Connector
Class Inheritance
All Implemented Interfaces
org.eclipse.persistence.sessions.Connector, java.lang.Cloneable, java.io.Serializable
Imports
java.io.*, java.util.*, javax.naming.*, jakarta.resource.*, jakarta.resource.cci.*, org.eclipse.persistence.sessions.*, org.eclipse.persistence.exceptions.*, org.eclipse.persistence.internal.helper.*

An EISConnectionSpec specifies how the jakarta.resource.cci.Connection is accessed. There are three ways to connect to an EIS datasource through JCA:

Author
James
Since
OracleAS TopLink 10g (10.0.3)
See Also
EISLogin

Field Summary

Modifier and TypeField and Description
protected ConnectionFactory
connectionFactory

protected ConnectionSpec
connectionSpec

protected Context
context

protected Writer
log

protected Name
name

public static final String
PASSWORD

public static final String
USER

Constructor Summary

AccessConstructor and Description
public
EISConnectionSpec()

PUBLIC: Construct a EISConnectionSpec with no settings.

public
EISConnectionSpec(Context context, String name)

PUBLIC: Construct a EISConnectionSpec with the specified settings.

public
EISConnectionSpec(String name)

PUBLIC: Construct a EISConnectionSpec with the specified settings.

public
EISConnectionSpec(Context context, Name name)

PUBLIC: Construct a EISConnectionSpec with the specified settings.

public
EISConnectionSpec(Name name)

PUBLIC: Construct a EISConnectionSpec with the specified settings.

Method Summary

Modifier and TypeMethod and Description
public Object
clone()

Overrides java.lang.Object.clone.

Implements org.eclipse.persistence.sessions.Connector.clone.

INTERNAL: Clone the connector.
public Connection
connect(Properties properties, Session session)

Implements org.eclipse.persistence.sessions.Connector.connect.

INTERNAL: Required for interface, but never used, for JDBC.
public Connection
connectToDataSource(EISAccessor accessor, Properties properties)

Connect with the specified properties and return the Connection.

public String

Returns:

java.lang.String
getConnectionDetails()

Implements org.eclipse.persistence.sessions.Connector.getConnectionDetails.

PUBLIC: Provide the details of my connection information.
public ConnectionFactory
getConnectionFactory()

PUBLIC: Return the jakarta.resource.cci.ConnectionFactory.

public ConnectionSpec
getConnectionSpec()

PUBLIC: Return the jakarta.resource.cci.ConnectionSpec.

public Context
getContext()

PUBLIC: Return the JNDI Context that can supplied the named ConnectionFactory.

public Writer
getLog()

PUBLIC: Returns the attunity adapter message log.

public Name
getName()

PUBLIC: Return the name of the ConnectionFactory within the JNDI Context.

public String
getPasswordFromProperties(Properties properties)

INTERNAL: Retrieve the password property from the supplied Properties object

public void
setConnectionFactory(ConnectionFactory connectionFactory)

PUBLIC: Set the jakarta.resource.cci.ConnectionFactory.

public void
setConnectionFactoryObject(Object connectionFactory)

PUBLIC: Set the jakarta.resource.cci.ConnectionFactory.

public void
setConnectionSpec(ConnectionSpec connectionSpec)

PUBLIC: Set the jakarta.resource.cci.ConnectionSpec.

public void
setConnectionSpecObject(Object connectionFactory)

PUBLIC: Set the jakarta.resource.cci.ConnectionSpec.

public void
setContext(Context context)

PUBLIC: Set the JNDI Context that can supply the named ConnectionFactory.

public void
setLog(Writer log)

PUBLIC: Sets the attunity adapter message log.

public void
setName(String name)

PUBLIC: Set the name of the ConnectionFactory within the JNDI Context.

public void
setName(Name name)

PUBLIC: Set the name of the ConnectionFactory within the JNDI Context.

public String
toString()

Overrides java.lang.Object.toString.

PUBLIC: Print data source info.
public void
toString(PrintWriter writer)

Implements org.eclipse.persistence.sessions.Connector.toString.

INTERNAL: Print something useful on the log.
Inherited from java.lang.Object:
equalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

connectionFactoryback to summary
protected ConnectionFactory connectionFactory
connectionSpecback to summary
protected ConnectionSpec connectionSpec
contextback to summary
protected Context context
logback to summary
protected Writer log
nameback to summary
protected Name name
PASSWORDback to summary
public static final String PASSWORD
USERback to summary
public static final String USER

Constructor Detail

EISConnectionSpecback to summary
public EISConnectionSpec()

PUBLIC: Construct a EISConnectionSpec with no settings. The ConnectionFactory name will still need to be set.

EISConnectionSpecback to summary
public EISConnectionSpec(Context context, String name) throws ValidationException

PUBLIC: Construct a EISConnectionSpec with the specified settings.

EISConnectionSpecback to summary
public EISConnectionSpec(String name) throws ValidationException

PUBLIC: Construct a EISConnectionSpec with the specified settings.

EISConnectionSpecback to summary
public EISConnectionSpec(Context context, Name name)

PUBLIC: Construct a EISConnectionSpec with the specified settings.

EISConnectionSpecback to summary
public EISConnectionSpec(Name name)

PUBLIC: Construct a EISConnectionSpec with the specified settings.

Method Detail

cloneback to summary
public Object clone()

Overrides java.lang.Object.clone.

Implements org.eclipse.persistence.sessions.Connector.clone.

INTERNAL: Clone the connector.

Returns:Object

Doc from java.lang.Object.clone.

a clone of this instance.

Annotations
@Override
connectback to summary
public Connection connect(Properties properties, Session session)

Implements org.eclipse.persistence.sessions.Connector.connect.

INTERNAL: Required for interface, but never used, for JDBC.

Returns:Connection

Doc from org.eclipse.persistence.sessions.Connector.connect.

java.sql.Connection

Annotations
@Override
connectToDataSourceback to summary
public Connection connectToDataSource(EISAccessor accessor, Properties properties) throws DatabaseException, ValidationException

Connect with the specified properties and return the Connection.

getConnectionDetailsback to summary
public String getConnectionDetails()

Implements org.eclipse.persistence.sessions.Connector.getConnectionDetails.

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

Returns:String

java.lang.String

Annotations
@Override
getConnectionFactoryback to summary
public ConnectionFactory getConnectionFactory()

PUBLIC: Return the jakarta.resource.cci.ConnectionFactory.

getConnectionSpecback to summary
public ConnectionSpec getConnectionSpec()

PUBLIC: Return the jakarta.resource.cci.ConnectionSpec.

getContextback to summary
public Context getContext()

PUBLIC: Return the JNDI Context that can supplied the named ConnectionFactory.

getLogback to summary
public Writer getLog()

PUBLIC: Returns the attunity adapter message log.

getNameback to summary
public Name getName()

PUBLIC: Return the name of the ConnectionFactory within the JNDI Context.

getPasswordFromPropertiesback to summary
public String getPasswordFromProperties(Properties properties)

INTERNAL: Retrieve the password property from the supplied Properties object

setConnectionFactoryback to summary
public void setConnectionFactory(ConnectionFactory connectionFactory)

PUBLIC: Set the jakarta.resource.cci.ConnectionFactory.

setConnectionFactoryObjectback to summary
public void setConnectionFactoryObject(Object connectionFactory)

PUBLIC: Set the jakarta.resource.cci.ConnectionFactory.

setConnectionSpecback to summary
public void setConnectionSpec(ConnectionSpec connectionSpec)

PUBLIC: Set the jakarta.resource.cci.ConnectionSpec. This is only required if the default getConnection() on the connection factory is not used. This must be set to the EIS adapter specific connection spec.

setConnectionSpecObjectback to summary
public void setConnectionSpecObject(Object connectionFactory)

PUBLIC: Set the jakarta.resource.cci.ConnectionSpec. This is only required if the default getConnection() on the connection factory is not used. This must be set to the EIS adapter specific connection spec.

setContextback to summary
public void setContext(Context context)

PUBLIC: Set the JNDI Context that can supply the named ConnectionFactory.

setLogback to summary
public void setLog(Writer log)

PUBLIC: Sets the attunity adapter message log.

setNameback to summary
public void setName(String name) throws ValidationException

PUBLIC: Set the name of the ConnectionFactory within the JNDI Context.

setNameback to summary
public void setName(Name name)

PUBLIC: Set the name of the ConnectionFactory within the JNDI Context.

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

PUBLIC: Print data source info.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations
@Override
toStringback to summary
public void toString(PrintWriter writer)

Implements org.eclipse.persistence.sessions.Connector.toString.

INTERNAL: Print something useful on the log.

Annotations
@Override