Save This Page
Home » glassfish-v2ur2-b04-src » javax.resource.spi » [javadoc | source]
javax.resource.spi
public interface: ManagedConnectionFactory [javadoc | source]

All Implemented Interfaces:
    Serializable

ManagedConnectionFactory instance is a factory of both ManagedConnection and EIS-specific connection factory instances. This interface supports connection pooling by providing methods for matching and creation of ManagedConnection instance. A ManagedConnectionFactory instance is required to be a JavaBean.
Method from javax.resource.spi.ManagedConnectionFactory Summary:
createConnectionFactory,   createConnectionFactory,   createManagedConnection,   equals,   getLogWriter,   hashCode,   matchManagedConnections,   setLogWriter
Method from javax.resource.spi.ManagedConnectionFactory Detail:
 public Object createConnectionFactory() throws ResourceException
    Creates a Connection Factory instance. The Connection Factory instance gets initialized with a default ConnectionManager provided by the resource adapter.
 public Object createConnectionFactory(ConnectionManager cxManager) throws ResourceException
    Creates a Connection Factory instance. The Connection Factory instance gets initialized with the passed ConnectionManager. In the managed scenario, ConnectionManager is provided by the application server.
 public ManagedConnection createManagedConnection(Subject subject,
    ConnectionRequestInfo cxRequestInfo) throws ResourceException
    Creates a new physical connection to the underlying EIS resource manager.

    ManagedConnectionFactory uses the security information (passed as Subject) and additional ConnectionRequestInfo (which is specific to ResourceAdapter and opaque to application server) to create this new connection.

 public boolean equals(Object other)
    Check if this ManagedConnectionFactory is equal to another ManagedConnectionFactory.
 public PrintWriter getLogWriter() throws ResourceException
    Get the log writer for this ManagedConnectionFactory instance.

    The log writer is a character output stream to which all logging and tracing messages for this ManagedConnectionFactory instance will be printed

    ApplicationServer manages the association of output stream with the ManagedConnectionFactory. When a ManagedConnectionFactory object is created the log writer is initially null, in other words, logging is disabled.

 public int hashCode()
    Returns the hash code for the ManagedConnectionFactory
 public ManagedConnection matchManagedConnections(Set connectionSet,
    Subject subject,
    ConnectionRequestInfo cxRequestInfo) throws ResourceException
    Returns a matched connection from the candidate set of connections.

    ManagedConnectionFactory uses the security info (as in Subject) and information provided through ConnectionRequestInfo and additional Resource Adapter specific criteria to do matching. Note that criteria used for matching is specific to a resource adapter and is not prescribed by the Connector specification.

    This method returns a ManagedConnection instance that is the best match for handling the connection allocation request.

 public  void setLogWriter(PrintWriter out) throws ResourceException
    Set the log writer for this ManagedConnectionFactory instance.

    The log writer is a character output stream to which all logging and tracing messages for this ManagedConnectionfactory instance will be printed.

    ApplicationServer manages the association of output stream with the ManagedConnectionFactory. When a ManagedConnectionFactory object is created the log writer is initially null, in other words, logging is disabled. Once a log writer is associated with a ManagedConnectionFactory, logging and tracing for ManagedConnectionFactory instance is enabled.

    The ManagedConnection instances created by ManagedConnectionFactory "inherits" the log writer, which can be overridden by ApplicationServer using ManagedConnection.setLogWriter to set ManagedConnection specific logging and tracing.