[Ejtools-cvs] libraries/j2ee.deployment/src/main/javax/enterprise/deploy/spi/factories DeploymentFactory.java,NONE,1.1 package.html,NONE,1.1

[<let...@us...>]

Update of /cvsroot/ejtools/libraries/j2ee.deployment/src/main/javax/enterprise/deploy/spi/factories
In directory sc8-pr-cvs1:/tmp/cvs-serv4692/src/main/javax/enterprise/deploy/spi/factories

Added Files:
	DeploymentFactory.java package.html 
Log Message:
Add up-to-date implementation for the JSR 88. No need for the Sun one.


--- NEW FILE: DeploymentFactory.java ---
/*
 * EJTools, the Enterprise Java Tools
 *
 * Distributable under LGPL license.
 * See terms of license at www.gnu.org.
 */
package javax.enterprise.deploy.spi.factories;

import javax.enterprise.deploy.spi.DeploymentManager;

import javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException;

/**
 * The DeploymentFactory interface is a deployment driver for a J2EE plaform product.
 * It returns a DeploymentManager object which represents a connection to a specific
 * J2EE platform product. <p>
 *
 * Each application server vendor must provide an implementation of this class in
 * order for the J2EE Deployment API to work with their product.</p> <p>
 *
 * The class implementing this interface should have a public no-argument constructor,
 * and it should be stateless (two instances of the class should always behave the
 * same). It is suggested but not required that the class have a static initializer
 * that registers an instance of the class with the DeploymentFactoryManager class.
 * </p> <p>
 *
 * A connected or disconnected DeploymentManager can be requested. A DeploymentManager
 * that runs connected to the platform can provide access to J2EE resources. A DeploymentManager
 * that runs disconnected only provides module deployment configuration support.</p>
 *
 * @author    Laurent Etiemble
 * @version   $Revision: 1.1 $
 * @since     1.0
 * @see       javax.enterprise.deploy.spi.DeploymentManager
 */
public interface DeploymentFactory
{
   /**
    * Tests whether this factory can create a DeploymentManager object based on the
    * specificed URI. This does not indicate whether such an attempt will be successful,
    * only whether the factory can handle the uri.
    *
    * @param uri  The uri to check
    * @return     true if the factory can handle the uri.
    */
   public boolean handlesURI(String uri);


   /**
    * Return a <code>connected</code> DeploymentManager instance.
    *
    * @param uri                                     The URI that specifies the connection
    *      parameters
    * @param username                                An optional username (may be
    *      null if no authentication is required for this platform).
    * @param password                                An optional password (may be
    *      null if no authentication is required for this platform).
    * @return                                        A ready DeploymentManager instance.
    * @exception DeploymentManagerCreationException  occurs when a DeploymentManager
    *      could not be returned (server down, unable to authenticate, etc).
    */
   public DeploymentManager getDeploymentManager(String uri, String username, String password)
      throws DeploymentManagerCreationException;


   /**
    * Return a <code>disconnected</code> DeploymentManager instance.
    *
    * @param uri                                     the uri of the DeploymentManager
    *      to return.
    * @return                                        A DeploymentManager disconnected
    *      instance.
    * @exception DeploymentManagerCreationException  occurs if the DeploymentManager
    *      could not be created.
    */
   public DeploymentManager getDisconnectedDeploymentManager(String uri)
      throws DeploymentManagerCreationException;


   /**
    * Provide a string with the name of this vendor's DeploymentManager.
    *
    * @return   the name of the vendor's DeploymentManager.
    */
   public String getDisplayName();


   /**
    * Provide a string identifying version of this vendor's DeploymentManager.
    *
    * @return   the name of the vendor's DeploymentManager.
    */
   public String getProductVersion();
}

--- NEW FILE: package.html ---
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--
  EJTools, the Enterprise Java Tools

  Distributable under LGPL license.
  See terms of license at www.gnu.org.
  
  $Revision: 1.1 $
-->
<html>
<head/>
<body>
Provides J2EE Product Vendor deployment factory implementation classes.

<h2>Package Specification</h2>
<ul>
   <li><a href="http://jcp.org/jsr/detail/88.jsp">JSR 88, J2EE Application Deployment</a></li>
</ul>

<h2>Related Documentation</h2>
For overviews, tutorials, examples, guides, and tool documentation, please see:
<ul>
   <li><a href="http://java.sun.com/j2ee/tools">J2EE Tools</a></li>
</ul>
</body>
</html>