/*
 * JBoss, the OpenSource EJB server
 * 
 * Distributable under LGPL license. See terms of license at gnu.org.
 */
package javax.resource.spi;

import java.io.PrintWriter;
import java.io.Serializable;
import java.util.Set;

import javax.resource.ResourceException;
import javax.security.auth.Subject;

/**
 * A ManagedConnectionFactory is a factory for the creation of
 * ManagedConnection objects and ConnectionFactory objects. It provides methods
 * which can be used to match ManagedConnetions.
 */
public interface ManagedConnectionFactory extends Serializable
{
   /**
     * Creates a connection factory instance. The connection manager is provided
    * by the resource adapter.
    * 
    * @return the connection factory
    * @throws ResourceException for a generic error 
    * @throws ResourceAdapterInternalException for an internal error in the
    *            resource adapter
     */
   public Object createConnectionFactory() throws ResourceException;

   /**
     * Creates a connection factory instance. the connection manager is provided
    * by the application server
    * 
    * @param cxManager the connection manager
    * @return the connection factory
    * @throws ResourceException for a generic error 
    * @throws ResourceAdapterInternalException for an internal error in the
    *            resource adapter
     */
   public Object createConnectionFactory(ConnectionManager cxManager) throws ResourceException;

   /**
     * Creates a new ManagedConnection
    * 
    * @param subject the subject
    * @param cxRequestInfo the connection request info
    * @return the managed connection
    * @throws ResourceException for a generic error 
    * @throws ResourceAllocationException for an error allocting resources
    * @throws ResourceAdapterInternalException for an internal error in the
    *            resource adapter
    * @throws SecurityException for a security problem
    * @throws EISSystemException for an error from the EIS
     */
   public ManagedConnection createManagedConnection(Subject subject, ConnectionRequestInfo cxRequestInfo)
         throws ResourceException;

   /**
    * Returns a matching connection from the set.
    * 
    * @param connectionSet the connection set
    * @param subject the subject
    * @param cxRequestInfo the connection request info
    * @return the managed connection
    * @throws ResourceException for a generic error 
    * @throws ResourceAdapterInternalException for an internal error in the
    *            resource adapter
    * @throws SecurityException for a security problem
    * @throws NotSupportedException if not supported
    */
   public ManagedConnection matchManagedConnections(Set connectionSet, Subject subject,
                                                    ConnectionRequestInfo cxRequestInfo) throws ResourceException;

   /**
    * Gets the logwriter for this instance.
    * 
    * @return the log writer
    * @throws ResourceException for a generic error 
    */
   public PrintWriter getLogWriter() throws ResourceException;
   
   /**
    * Sets the logwriter for this instance.
    * 
    * @param out the log writer
    * @throws ResourceException for a generic error 
    * @throws ResourceAdapterInternalException for an internal error in the
    *            resource adapter
    */
   public void setLogWriter(PrintWriter out) throws ResourceException;
   
   /**
     * Tests object for equality
    * 
    * @param other the other object
    * @return true when equals, false otherwise
     */
   public boolean equals(Object other);

   /**
     * Generates a hashCode for this object
    * 
    * @return the hash code
     */
   public int hashCode();
}