Overview | Package | Class | Tree | Deprecated | Index | Help
| Oracle TopLink API Reference 10g Release 3 (10.1.3) B13698-01
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## oracle.toplink.eis
Class EISConnectionSpec

`java.lang.Object
oracle.toplink.eis.EISConnectionSpec`

All Implemented Interfaces:
  java.lang.Cloneable, Connector, java.io.Serializable

Direct Known Subclasses:
  AQEISConnectionSpec, AttunityConnectionSpec, BlackboxConnectionSpec, JMSEISConnectionSpec, XMLFileEISConnectionSpec

public class EISConnectionSpec
extends java.lang.Object
implements Connector

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

- Provide a JNDI name to the ConnectionFactory and use the default getConnection
- Provide a JNDI name to the ConnectionFactory, and a driver specific ConnectionSpec to pass to the getConnection
- Connect in a non-managed way directly to the driver specific ConnectionFactory
  Since:
    OracleAS TopLink 10g (10.0.3)
  See Also:
    `EISLogin`, Serialized Form

  Field Summary
  `static java.lang.String` | `PASSWORD`
  `static java.lang.String` | `USER`

  Constructor Summary
  `EISConnectionSpec()` PUBLIC: Construct a EISConnectionSpec with no settings.
  `EISConnectionSpec(javax.naming.Context context, javax.naming.Name name)` PUBLIC: Construct a EISConnectionSpec with the specified settings.
  `EISConnectionSpec(javax.naming.Context context, java.lang.String name)` PUBLIC: Construct a EISConnectionSpec with the specified settings.
  `EISConnectionSpec(javax.naming.Name name)` PUBLIC: Construct a EISConnectionSpec with the specified settings.
  `EISConnectionSpec(java.lang.String name)` PUBLIC: Construct a EISConnectionSpec with the specified settings.

  Method Summary
  `javax.resource.cci.Connection` | `connectToDataSource(EISAccessor accessor, java.util.Properties properties)` Connect with the specified properties and return the Connection.
  `java.lang.String` | `getConnectionDetails()` PUBLIC: Provide the details of my connection information.
  `javax.resource.cci.ConnectionFactory` | `getConnectionFactory()` PUBLIC: Return the javax.resource.cci.ConnectionFactory.
  `javax.resource.cci.ConnectionSpec` | `getConnectionSpec()` PUBLIC: Return the javax.resource.cci.ConnectionSpec.
  `javax.naming.Context` | `getContext()` PUBLIC: Return the JNDI Context that can supplied the named ConnectionFactory.
  `java.io.Writer` | `getLog()` PUBLIC: Returns the attunity adapter message log.
  `javax.naming.Name` | `getName()` PUBLIC: Return the name of the ConnectionFactory within the JNDI Context.
  `void` | `setConnectionFactory(javax.resource.cci.ConnectionFactory connectionFactory)` PUBLIC: Set the javax.resource.cci.ConnectionFactory.
  `void` | `setConnectionSpec(javax.resource.cci.ConnectionSpec connectionSpec)` PUBLIC: Set the javax.resource.cci.ConnectionSpec.
  `void` | `setContext(javax.naming.Context context)` PUBLIC: Set the JNDI Context that can supply the named ConnectionFactory.
  `void` | `setLog(java.io.Writer log)` PUBLIC: Sets the attunity adapter message log.
  `void` | `setName(javax.naming.Name name)` PUBLIC: Set the name of the ConnectionFactory within the JNDI Context.
  `void` | `setName(java.lang.String name)` PUBLIC: Set the name of the ConnectionFactory within the JNDI Context.
  `java.lang.String` | `toString()` PUBLIC: Print data source info.

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

  Field Detail

  ### USER

      public static final java.lang.String USER

    See Also:
      Constant Field Values

  ### PASSWORD

      public static final java.lang.String PASSWORD

    See Also:
      Constant Field Values

  Constructor Detail

  ### EISConnectionSpec

      public EISConnectionSpec()

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

  ### EISConnectionSpec

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

    PUBLIC: Construct a EISConnectionSpec with the specified settings.

  ### EISConnectionSpec

      public EISConnectionSpec(java.lang.String name)
                        throws ValidationException

    PUBLIC: Construct a EISConnectionSpec with the specified settings.

  ### EISConnectionSpec

      public EISConnectionSpec(javax.naming.Context context,
                               javax.naming.Name name)

    PUBLIC: Construct a EISConnectionSpec with the specified settings.

  ### EISConnectionSpec

      public EISConnectionSpec(javax.naming.Name name)

    PUBLIC: Construct a EISConnectionSpec with the specified settings.

  Method Detail

  ### getLog

      public java.io.Writer getLog()

    PUBLIC: Returns the attunity adapter message log.

  ### setLog

      public void setLog(java.io.Writer log)

    PUBLIC: Sets the attunity adapter message log.

  ### connectToDataSource

      public javax.resource.cci.Connection connectToDataSource(EISAccessor accessor,
                                                               java.util.Properties properties)
                                                        throws DatabaseException,
                                                               ValidationException

    Connect with the specified properties and return the Connection.
    Throws:
      `DatabaseException`
      `ValidationException`

  ### getContext

      public javax.naming.Context getContext()

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

  ### getConnectionFactory

      public javax.resource.cci.ConnectionFactory getConnectionFactory()

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

  ### getConnectionSpec

      public javax.resource.cci.ConnectionSpec getConnectionSpec()

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

  ### getName

      public javax.naming.Name getName()

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

  ### getConnectionDetails

      public java.lang.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(javax.naming.Context context)

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

  ### setConnectionFactory

      public void setConnectionFactory(javax.resource.cci.ConnectionFactory connectionFactory)

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

  ### setConnectionSpec

      public void setConnectionSpec(javax.resource.cci.ConnectionSpec connectionSpec)

    PUBLIC: Set the javax.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.

  ### setName

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

    PUBLIC: Set the name of the ConnectionFactory within the JNDI Context.
    Throws:
      `ValidationException`

  ### setName

      public void setName(javax.naming.Name name)

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

  ### toString

      public java.lang.String toString()

    PUBLIC: Print data source info.

  Overview | Package | Class | Tree | Deprecated | Index | Help
  | Copyright © 1998, 2006, Oracle. All Rights Reserved.
  PREV CLASS NEXT CLASS | FRAMES NO FRAMES
  SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD