01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package javax.enterprise.deploy.spi.factories;
23:
24: import javax.enterprise.deploy.spi.DeploymentManager;
25: import javax.enterprise.deploy.spi.exceptions.DeploymentManagerCreationException;
26:
27: /**
28: * Each application server vendor must provide an implementation of this class in order for the J2EE Deployment API
29: * to work with their product.
30: *
31: * The class implementing this interface should have a public no-argument constructor,
32: * and it should be stateless (two instances of the class should always behave the same).
33: * It is suggested but not required that the class have a static initializer that registers an instance
34: * of the class with the DeploymentFactoryManager class.
35: *
36: * A connected or disconnected DeploymentManager can be requested. A DeploymentManager that runs connected
37: * to the platform can provide access to J2EE resources. A DeploymentManager that runs disconnected only provides
38: * module deployment configuration support.
39: *
40: * @author <a href="mailto:adrian@jboss.org">Adrian Brock</a>
41: * @version $Revision: 57196 $
42: */
43: public interface DeploymentFactory {
44: // Constants -----------------------------------------------------
45:
46: // Public --------------------------------------------------------
47:
48: /**
49: * Tests whether the factory can create a manager for the URI
50: *
51: * @param uri the uri
52: * @return true when it can, false otherwise
53: */
54: boolean handlesURI(String uri);
55:
56: /**
57: * Get a connected deployment manager
58: *
59: * @param uri the uri of the deployment manager
60: * @param userName the user name
61: * @param password the password
62: * @return the deployment manager
63: * @throws DeploymentManagerCreationException
64: */
65: DeploymentManager getDeploymentManager(String uri, String userName,
66: String password) throws DeploymentManagerCreationException;
67:
68: /**
69: * Get a disconnected version of the deployment manager
70: *
71: * @param uri the uri to connect to
72: * @return the disconnected deployment manager
73: * @throws DeploymentManagerCreationException
74: */
75: DeploymentManager getDisconnectedDeploymentManager(String uri)
76: throws DeploymentManagerCreationException;
77:
78: /**
79: * The vendor of the deployment manager
80: *
81: * @return the vendor name
82: */
83: String getDisplayName();
84:
85: /**
86: * The version of the deployment manager
87: *
88: * @return the version
89: */
90: String getProductVersion();
91: }
|