jboynes 2003/09/03 22:41:21
Modified: specs/j2ee-deployment/src/java/javax/enterprise/deploy/shared
ActionType.java CommandType.java
DConfigBeanVersionType.java ModuleType.java
StateType.java
specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/exceptions
BeanNotFoundException.java
ClientExecuteException.java
ConfigurationException.java
DConfigBeanVersionUnsupportedException.java
DeploymentManagerCreationException.java
InvalidModuleException.java
OperationUnsupportedException.java
TargetException.java
specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/factories
DeploymentFactory.java
specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/status
ClientConfiguration.java DeploymentStatus.java
ProgressEvent.java ProgressListener.java
ProgressObject.java
Log:
GERONIMO-41,42,43 patch from Aaron Mulder (javadoc only)
Revision Changes Path
1.2 +43 -7
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/shared/ActionType.java
Index: ActionType.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/shared/ActionType.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ActionType.java 16 Aug 2003 12:28:26 -0000 1.1
+++ ActionType.java 4 Sep 2003 05:41:20 -0000 1.2
@@ -60,16 +60,24 @@
package javax.enterprise.deploy.shared;
/**
+ * Class ActionTypes defines enumeration values for the J2EE DeploymentStatus
+ * actions.
*
* @version $Revision$ $Date$
*/
public class ActionType {
- private static int MAX_VALUE = 2;
-
+ /**
+ * The action is currently executing.
+ */
public static final ActionType EXECUTE = new ActionType(0);
+ /**
+ * The action has been canceled.
+ */
public static final ActionType CANCEL = new ActionType(1);
- public static final ActionType STOP = new ActionType(MAX_VALUE);
-
+ /**
+ * A stop operation is being preformed on the DeploymentManager action
command.
+ */
+ public static final ActionType STOP = new ActionType(2);
private static final ActionType[] enumValueTable = new ActionType[]{
EXECUTE,
@@ -85,31 +93,59 @@
private int value;
-
+ /**
+ * Construct a new enumeration value with the given integer value.
+ */
protected ActionType(int value) {
this.value = value;
}
+ /**
+ * Returns this enumeration value's integer value.
+ *
+ * @return the value
+ */
public int getValue() {
return value;
}
+ /**
+ * Returns the string table for class ActionType
+ */
protected String[] getStringTable() {
return stringTable;
}
+ /**
+ * Returns the enumeration value table for class ActionType
+ */
protected ActionType[] getEnumValueTable() {
return enumValueTable;
}
+ /**
+ * Return an object of the specified value.
+ *
+ * @param value a designator for the object.
+ */
public static ActionType getActionType(int value) {
return enumValueTable[value];
}
+ /**
+ * Return the string name of this ActionType or the integer value if
+ * outside the bounds of the table
+ */
public String toString() {
- return (value >= getOffset() && value <= getOffset() + MAX_VALUE) ?
getStringTable()[value] : String.valueOf(value);
+ return (value >= 0 && value <= 2) ? stringTable[value] :
String.valueOf(value);
}
+ /**
+ * Returns the lowest integer value used by this enumeration value's
+ * enumeration class.
+ *
+ * @return the offset of the lowest enumeration value.
+ */
protected int getOffset() {
return 0;
}
1.2 +45 -4
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/shared/CommandType.java
Index: CommandType.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/shared/CommandType.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- CommandType.java 16 Aug 2003 12:28:26 -0000 1.1
+++ CommandType.java 4 Sep 2003 05:41:20 -0000 1.2
@@ -60,16 +60,30 @@
package javax.enterprise.deploy.shared;
/**
+ * Defines enumerated values for the available deployment commands.
*
* @version $Revision$ $Date$
*/
public class CommandType {
- private static final int MAX_VALUE = 4;
-
+ /**
+ * The DeploymentManger action operation being processed is distribute.
+ */
public static final CommandType DISTRIBUTE = new CommandType(0);
+ /**
+ * The DeploymentManger action operation being processed is start.
+ */
public static final CommandType START = new CommandType(1);
+ /**
+ * The DeploymentManger action operation being processed is stop.
+ */
public static final CommandType STOP = new CommandType(2);
+ /**
+ * The DeploymentManger action operation being processed is undeploy.
+ */
public static final CommandType UNDEPLOY = new CommandType(3);
+ /**
+ * he DeploymentManger action operation being processed is redeploy.
+ */
public static final CommandType REDEPLOY = new CommandType(4);
private static final CommandType[] enumValueTable = new CommandType[]{
@@ -90,30 +104,57 @@
private int value;
+ /**
+ * Construct a new enumeration value with the given integer value.
+ */
protected CommandType(int value) {
this.value = value;
}
+ /**
+ * Returns this enumeration value's integer value.
+ */
public int getValue() {
return value;
}
+ /**
+ * Returns the string table for class CommandType
+ */
protected String[] getStringTable() {
return stringTable;
}
+ /**
+ * Returns the enumeration value table for class CommandType
+ */
protected CommandType[] getEnumValueTable() {
return enumValueTable;
}
+ /**
+ * Return an object of the specified value.
+ *
+ * @param value a designator for the object.
+ */
public static CommandType getCommandType(int value) {
return enumValueTable[value];
}
+ /**
+ * Return the string name of this CommandType or the integer value if
+ * outside the bounds of the table
+ */
public String toString() {
- return (value >= getOffset() && value <= getOffset() + MAX_VALUE) ?
getStringTable()[value] : String.valueOf(value);
+ return (value >= 0 && value <= 4) ? stringTable[value] :
String.valueOf(value);
}
+ /**
+ * Returns the lowest integer value used by this enumeration value's
+ * enumeration class.
+ *
+ * @return the offset of the lowest enumeration value.
+ */
protected int getOffset() {
return 0;
}
1.2 +40 -5
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/shared/DConfigBeanVersionType.java
Index: DConfigBeanVersionType.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/shared/DConfigBeanVersionType.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DConfigBeanVersionType.java 16 Aug 2003 12:28:26 -0000 1.1
+++ DConfigBeanVersionType.java 4 Sep 2003 05:41:20 -0000 1.2
@@ -60,15 +60,23 @@
package javax.enterprise.deploy.shared;
/**
+ * Class DConfigBeanVersionTypes defines enumeration values for the J2EE
+ * Platform verion number.
*
* @version $Revision$ $Date$
*/
public class DConfigBeanVersionType {
- private static final int MAX_VALUE = 2;
-
+ /**
+ * J2EE Platform version 1.3
+ */
public static final DConfigBeanVersionType V1_3 = new
DConfigBeanVersionType(0);
+ /**
+ * J2EE Platform version 1.3.1
+ */
public static final DConfigBeanVersionType V1_3_1 = new
DConfigBeanVersionType(1);
- // Found during unittesting against Sun RI. Not in API doc, but expected.
+ /**
+ * J2EE Platform version 1.4
+ */
public static final DConfigBeanVersionType V1_4 = new
DConfigBeanVersionType(2);
private static final DConfigBeanVersionType[] enumValueTable = {
@@ -85,30 +93,57 @@
private int value;
+ /**
+ * Construct a new enumeration value with the given integer value.
+ */
protected DConfigBeanVersionType(int value) {
this.value = value;
}
+ /**
+ * Returns this enumeration value's integer value.
+ */
public int getValue() {
return value;
}
+ /**
+ * Returns the string table for class DConfigBeanVersionType
+ */
protected String[] getStringTable() {
return stringTable;
}
+ /**
+ * Returns the enumeration value table for class DConfigBeanVersionType
+ */
protected DConfigBeanVersionType[] getEnumValueTable() {
return enumValueTable;
}
+ /**
+ * Return an object of the specified value.
+ *
+ * @param value a designator for the object.
+ */
public static DConfigBeanVersionType getDConfigBeanVersionType(int
value) {
return enumValueTable[value];
}
+ /**
+ * Return the string name of this DConfigBeanVersionType or the integer
+ * value if outside the bounds of the table
+ */
public String toString() {
- return (value >= getOffset() && value <= getOffset() + MAX_VALUE) ?
getStringTable()[value] : String.valueOf(value);
+ return (value >= 0 && value <= 2) ? getStringTable()[value] :
String.valueOf(value);
}
+ /**
+ * Returns the lowest integer value used by this enumeration value's
+ * enumeration class.
+ *
+ * @return the offset of the lowest enumeration value.
+ */
protected int getOffset() {
return 0;
}
1.2 +48 -4
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/shared/ModuleType.java
Index: ModuleType.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/shared/ModuleType.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ModuleType.java 16 Aug 2003 12:28:26 -0000 1.1
+++ ModuleType.java 4 Sep 2003 05:41:20 -0000 1.2
@@ -60,16 +60,30 @@
package javax.enterprise.deploy.shared;
/**
+ * Class ModuleTypes defines enumeration values for the J2EE module types.
*
* @version $Revision$ $Date$
*/
public class ModuleType {
- private static final int MAX_VALUE = 4;
-
+ /**
+ * The module is an EAR archive.
+ */
public static final ModuleType EAR = new ModuleType(0);
+ /**
+ * The module is an Enterprise Java Bean archive.
+ */
public static final ModuleType EJB = new ModuleType(1);
+ /**
+ * The module is an Client Application archive.
+ */
public static final ModuleType CAR = new ModuleType(2);
+ /**
+ * The module is an Connector archive.
+ */
public static final ModuleType RAR = new ModuleType(3);
+ /**
+ * The module is an Web Application archive.
+ */
public static final ModuleType WAR = new ModuleType(4);
private static final ModuleType[] enumValueTable = {
@@ -98,34 +112,64 @@
private int value;
+ /**
+ * Construct a new enumeration value with the given integer value.
+ */
protected ModuleType(int value) {
this.value = value;
}
+ /**
+ * Returns this enumeration value's integer value.
+ */
public int getValue() {
return value;
}
+ /**
+ * Returns the string table for class ModuleType
+ */
protected String[] getStringTable() {
return stringTable;
}
+ /**
+ * Returns the enumeration value table for class ModuleType
+ */
protected ModuleType[] getEnumValueTable() {
return enumValueTable;
}
+ /**
+ * Return the file extension string for this enumeration.
+ */
public String getModuleExtension() {
return moduleExtensionTable[value];
}
+ /**
+ * Return an object of the specified value.
+ *
+ * @param value a designator for the object.
+ */
public static ModuleType getModuleType(int value) {
return enumValueTable[value];
}
+ /**
+ * Return the string name of this ModuleType or the integer value if
+ * outside the bounds of the table
+ */
public String toString() {
- return (value >= getOffset() && value <= getOffset() + MAX_VALUE) ?
getStringTable()[value] : String.valueOf(value);
+ return (value >= 0 && value <= 4) ? stringTable[value] :
String.valueOf(value);
}
+ /**
+ * Returns the lowest integer value used by this enumeration value's
+ * enumeration class.
+ *
+ * @return the offset of the lowest enumeration value.
+ */
protected int getOffset() {
return 0;
}
1.2 +42 -3
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/shared/StateType.java
Index: StateType.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/shared/StateType.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- StateType.java 16 Aug 2003 12:28:26 -0000 1.1
+++ StateType.java 4 Sep 2003 05:41:20 -0000 1.2
@@ -60,14 +60,26 @@
package javax.enterprise.deploy.shared;
/**
+ * Defines enumeration values for the various states of a deployment action.
*
* @version $Revision$ $Date$
*/
public class StateType {
- private static final int MAX_VALUE = 3;
+ /**
+ * The action operation is running normally.
+ */
public static final StateType RUNNING = new StateType(0);
+ /**
+ * The action operation has completed normally.
+ */
public static final StateType COMPLETED = new StateType(1);
+ /**
+ * The action operation has failed.
+ */
public static final StateType FAILED = new StateType(2);
+ /**
+ * The DeploymentManager is running in disconnected mode.
+ */
public static final StateType RELEASED = new StateType(3);
private static final StateType[] enumValueTable = {
@@ -86,30 +98,57 @@
private int value;
+ /**
+ * Construct a new enumeration value with the given integer value.
+ */
protected StateType(int value) {
this.value = value;
}
+ /**
+ * Returns this enumeration value's integer value.
+ */
public int getValue() {
return value;
}
+ /**
+ * Returns the string table for class StateType
+ */
protected String[] getStringTable() {
return stringTable;
}
+ /**
+ * Returns the enumeration value table for class StateType
+ */
protected StateType[] getEnumValueTable() {
return enumValueTable;
}
+ /**
+ * Return an object of the specified value.
+ *
+ * @param value a designator for the object.
+ */
public static StateType getStateType(int value) {
return enumValueTable[value];
}
+ /**
+ * Return the string name of this StateType or the integer value if
+ * outside the bounds of the table
+ */
public String toString() {
- return (value >= getOffset() && value <= getOffset() + MAX_VALUE) ?
getStringTable()[value] : String.valueOf(value);
+ return (value >= 0 && value <= 3) ? stringTable[value] :
String.valueOf(value);
}
+ /**
+ * Returns the lowest integer value used by this enumeration value's
+ * enumeration class.
+ *
+ * @return the offset of the lowest enumeration value.
+ */
protected int getOffset() {
return 0;
}
1.2 +7 -1
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/exceptions/BeanNotFoundException.java
Index: BeanNotFoundException.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/exceptions/BeanNotFoundException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- BeanNotFoundException.java 16 Aug 2003 12:28:26 -0000 1.1
+++ BeanNotFoundException.java 4 Sep 2003 05:41:21 -0000 1.2
@@ -60,10 +60,16 @@
package javax.enterprise.deploy.spi.exceptions;
/**
+ * This exception is to report that the bean is not a child of the parent
bean.
*
* @version $Revision$ $Date$
*/
public class BeanNotFoundException extends Exception {
+ /**
+ * Creates an new BeanNotFoundException object.
+ *
+ * @param s a string indicating what was wrong with the target.
+ */
public BeanNotFoundException(String s) {
super(s);
}
1.2 +12 -1
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/exceptions/ClientExecuteException.java
Index: ClientExecuteException.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/exceptions/ClientExecuteException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ClientExecuteException.java 16 Aug 2003 12:28:26 -0000 1.1
+++ ClientExecuteException.java 4 Sep 2003 05:41:21 -0000 1.2
@@ -60,14 +60,25 @@
package javax.enterprise.deploy.spi.exceptions;
/**
+ * This exception reports errors in setting up an application client for
+ * execution.
*
* @version $Revision$ $Date$
*/
public class ClientExecuteException extends Exception {
+ /**
+ * Creates new <tt>ClientExecuteException</tt> without a detail message.
+ */
public ClientExecuteException() {
super();
}
+ /**
+ * Constructs a <tt>ClientExecuteException</tt> with the specified detail
+ * message.
+ *
+ * @param msg the detail message.
+ */
public ClientExecuteException(String msg) {
super(msg);
}
1.2 +11 -1
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/exceptions/ConfigurationException.java
Index: ConfigurationException.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/exceptions/ConfigurationException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ConfigurationException.java 16 Aug 2003 12:28:26 -0000 1.1
+++ ConfigurationException.java 4 Sep 2003 05:41:21 -0000 1.2
@@ -60,14 +60,24 @@
package javax.enterprise.deploy.spi.exceptions;
/**
+ * This exception reports errors in generating a configuration bean.
*
* @version $Revision$ $Date$
*/
public class ConfigurationException extends Exception {
+ /**
+ * Creates new <tt>ConfigurationException</tt> without a detail message.
+ */
public ConfigurationException() {
super();
}
+ /**
+ * Constructs a <tt>ConfigurationException</tt> with the specified detail
+ * message.
+ *
+ * @param msg the detail message.
+ */
public ConfigurationException(String msg) {
super(msg);
}
1.2 +6 -1
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/exceptions/DConfigBeanVersionUnsupportedException.java
Index: DConfigBeanVersionUnsupportedException.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/exceptions/DConfigBeanVersionUnsupportedException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DConfigBeanVersionUnsupportedException.java 16 Aug 2003 12:28:26
-0000 1.1
+++ DConfigBeanVersionUnsupportedException.java 4 Sep 2003 05:41:21
-0000 1.2
@@ -60,10 +60,15 @@
package javax.enterprise.deploy.spi.exceptions;
/**
+ * This exception is to report that there is no support for the DConfigBean
+ * version requested.
*
* @version $Revision$ $Date$
*/
public class DConfigBeanVersionUnsupportedException extends Exception {
+ /**
+ * Creates a new DConfigBeanVersionUnsupportedException.
+ */
public DConfigBeanVersionUnsupportedException(String s) {
super(s);
}
1.2 +8 -1
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/exceptions/DeploymentManagerCreationException.java
Index: DeploymentManagerCreationException.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/exceptions/DeploymentManagerCreationException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DeploymentManagerCreationException.java 16 Aug 2003 12:28:26 -0000
1.1
+++ DeploymentManagerCreationException.java 4 Sep 2003 05:41:21 -0000
1.2
@@ -60,10 +60,17 @@
package javax.enterprise.deploy.spi.exceptions;
/**
+ * This exception is to report problems in returning a DeploymentManager
object
+ * caused by such things as server down, unable to authenticate and the like.
*
* @version $Revision$ $Date$
*/
public class DeploymentManagerCreationException extends Exception {
+ /**
+ * Creates a new DeploymentManagerCreationException.
+ *
+ * @param s a string providing more information about the problem.
+ */
public DeploymentManagerCreationException(String s) {
super(s);
}
1.2 +7 -1
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/exceptions/InvalidModuleException.java
Index: InvalidModuleException.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/exceptions/InvalidModuleException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- InvalidModuleException.java 16 Aug 2003 12:28:26 -0000 1.1
+++ InvalidModuleException.java 4 Sep 2003 05:41:21 -0000 1.2
@@ -60,10 +60,16 @@
package javax.enterprise.deploy.spi.exceptions;
/**
+ * This exception is to report an invalid J2EE deployment module type.
*
* @version $Revision$ $Date$
*/
public class InvalidModuleException extends Exception {
+ /**
+ * Creates a new InvalidModuleException.
+ *
+ * @param s a string indicating what was wrong with the module type.
+ */
public InvalidModuleException(String s) {
super(s);
}
1.2 +9 -1
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/exceptions/OperationUnsupportedException.java
Index: OperationUnsupportedException.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/exceptions/OperationUnsupportedException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- OperationUnsupportedException.java 16 Aug 2003 12:28:26 -0000
1.1
+++ OperationUnsupportedException.java 4 Sep 2003 05:41:21 -0000
1.2
@@ -60,10 +60,18 @@
package javax.enterprise.deploy.spi.exceptions;
/**
+ * This exception is to report that the method called is not supported by
this
+ * implementation.
*
* @version $Revision$ $Date$
*/
public class OperationUnsupportedException extends Exception {
+ /**
+ * Creates a new OperationUnsupportedException.
+ *
+ * @param s a string giving more information about the unsupported
+ * operation.
+ */
public OperationUnsupportedException(String s) {
super(s);
}
1.2 +10 -1
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/exceptions/TargetException.java
Index: TargetException.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/exceptions/TargetException.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- TargetException.java 16 Aug 2003 12:28:26 -0000 1.1
+++ TargetException.java 4 Sep 2003 05:41:21 -0000 1.2
@@ -60,10 +60,19 @@
package javax.enterprise.deploy.spi.exceptions;
/**
+ * This exception is to report bad target designators. Likely causes
include:
+ * the server has been reconfigured since the target was originally provided,
+ * or the tools is forging targets instead of using the ones provided by the
+ * DeploymentManager.
*
* @version $Revision$ $Date$
*/
public class TargetException extends Exception {
+ /**
+ * Creates a new TargetException.
+ *
+ * @param s a string indicating what was wrong with the target.
+ */
public TargetException(String s) {
super(s);
}
1.2 +65 -1
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/factories/DeploymentFactory.java
Index: DeploymentFactory.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/factories/DeploymentFactory.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DeploymentFactory.java 16 Aug 2003 12:28:27 -0000 1.1
+++ DeploymentFactory.java 4 Sep 2003 05:41:21 -0000 1.2
@@ -63,17 +63,81 @@
import javax.enterprise.deploy.spi.DeploymentManager;
/**
+ * 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.
+ *
+ * Each application server vendor must provide an implementation of this
class
+ * in order for the J2EE Deployment API to work with their product.
+ *
+ * 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.
+ *
+ * A <tt>connected</tt> or <tt>disconnected</tt> 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.
+ *
+ * @see javax.enterprise.deploy.shared.factories.DeploymentFactoryManager
*
* @version $Revision$ $Date$
*/
public interface DeploymentFactory {
+ /**
+ * Tests whether this factory can create a DeploymentManager object based
+ * on the specified 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 <tt>true</tt> if the factory can handle the uri.
+ */
public boolean handlesURI(String uri);
+ /**
+ * Returns a <tt>connected</tt> DeploymentManager instance.
+ *
+ * @param uri The URI that specifies the connection parameters
+ * @param username An optional username (may be <tt>null</tt> if no
+ * authentication is required for this platform).
+ * @param password An optional password (may be <tt>null</tt> if no
+ * authentication is required for this platform).
+ *
+ * @return A ready DeploymentManager instance.
+ *
+ * @throws 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;
+ /**
+ * Returns a <tt>disconnected</tt> DeploymentManager instance.
+ *
+ * @param uri the uri of the DeploymentManager to return.
+ *
+ * @return A DeploymentManager <tt>disconnected</tt> instance.
+ *
+ * @throws 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();
+ /**
+ * Provides a string identifying the version of this vendor's
+ * DeploymentManager.
+ *
+ * @return the name of the vendor's DeploymentManager.
+ */
public String getProductVersion();
}
1.2 +10 -1
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/status/ClientConfiguration.java
Index: ClientConfiguration.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/status/ClientConfiguration.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ClientConfiguration.java 16 Aug 2003 12:28:27 -0000 1.1
+++ ClientConfiguration.java 4 Sep 2003 05:41:21 -0000 1.2
@@ -63,9 +63,18 @@
import java.io.Serializable;
/**
+ * The ClientConfiguration object installs, configures and executes an
+ * Application Client. This class resolves the settings for installing and
+ * running the application client.
*
* @version $Revision$ $Date$
*/
public interface ClientConfiguration extends Serializable {
+ /**
+ * This method performs an exec and starts the application client running
+ * in another process.
+ *
+ * @throws ClientExecuteException when the configuration is incomplete.
+ */
public void execute() throws ClientExecuteException;
}
1.2 +38 -1
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/status/DeploymentStatus.java
Index: DeploymentStatus.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/status/DeploymentStatus.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- DeploymentStatus.java 16 Aug 2003 12:28:27 -0000 1.1
+++ DeploymentStatus.java 4 Sep 2003 05:41:21 -0000 1.2
@@ -64,21 +64,58 @@
import javax.enterprise.deploy.shared.ActionType;
/**
+ * The DeploymentStatus interface provides information about the progress of
a
+ * deployment action.
*
* @version $Revision$ $Date$
*/
public interface DeploymentStatus {
+ /**
+ * Retrieve the StateType value.
+ *
+ * @return the StateType object
+ */
public StateType getState();
+ /**
+ * Retrieve the deployment CommandType of this event.
+ *
+ * @return the CommandType Object
+ */
public CommandType getCommand();
+ /**
+ * Retrieve the deployment ActionType for this event.
+ *
+ * @return the ActionType Object
+ */
public ActionType getAction();
+ /**
+ * Retrieve any additional information about the status of this event.
+ *
+ * @return message text
+ */
public String getMessage();
+ /**
+ * A convience method to report if the operation is in the completed
state.
+ *
+ * @return <tt>true</tt> if this command has completed successfully
+ */
public boolean isCompleted();
+ /**
+ * A convience method to report if the operation is in the failed state.
+ *
+ * @return <tt>true</tt> if this command has failed
+ */
public boolean isFailed();
+ /**
+ * A convience method to report if the operation is in the running state.
+ *
+ * @return <tt>true</tt> if this command is still running
+ */
public boolean isRunning();
}
1.2 +23 -1
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/status/ProgressEvent.java
Index: ProgressEvent.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/status/ProgressEvent.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ProgressEvent.java 16 Aug 2003 12:28:27 -0000 1.1
+++ ProgressEvent.java 4 Sep 2003 05:41:21 -0000 1.2
@@ -63,6 +63,10 @@
import java.util.EventObject;
/**
+ * An event which indicates that a deployment status change has occurred.
+ *
+ * @see ProgressObject
+ * @see ProgressListener
*
* @version $Revision$ $Date$
*/
@@ -70,16 +74,34 @@
private TargetModuleID targetModuleID;
private DeploymentStatus deploymentStatus;
+ /**
+ * Creates a new object representing a deployment progress event.
+ *
+ * @param source the object on which the Event initially
occurred.
+ * @param targetModuleID the combination of target and module for which
the
+ * event occured.
+ * @param sCode the object containing the status information.
+ */
public ProgressEvent(Object source, TargetModuleID targetModuleID,
DeploymentStatus sCode) {
super(source);
this.targetModuleID = targetModuleID;
this.deploymentStatus = sCode;
}
+ /**
+ * Retrieves the TargetModuleID for this event.
+ *
+ * @return the TargetModuleID
+ */
public TargetModuleID getTargetModuleID() {
return targetModuleID;
}
+ /**
+ * Retrieves the status information for this event.
+ *
+ * @return the object containing the status information.
+ */
public DeploymentStatus getDeploymentStatus() {
return deploymentStatus;
}
1.2 +7 -1
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/status/ProgressListener.java
Index: ProgressListener.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/status/ProgressListener.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ProgressListener.java 16 Aug 2003 12:28:27 -0000 1.1
+++ ProgressListener.java 4 Sep 2003 05:41:21 -0000 1.2
@@ -62,9 +62,15 @@
import java.util.EventListener;
/**
+ * The listener interface for receiving deployment progress events.
*
* @version $Revision$ $Date$
*/
public interface ProgressListener extends EventListener {
+ /**
+ * Invoked when a deployment progress event occurs.
+ *
+ * @param event the progress event.
+ */
public void handleProgressEvent(ProgressEvent event);
}
1.2 +70 -1
incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/status/ProgressObject.java
Index: ProgressObject.java
===================================================================
RCS file:
/home/cvs/incubator-geronimo/specs/j2ee-deployment/src/java/javax/enterprise/deploy/spi/status/ProgressObject.java,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- ProgressObject.java 16 Aug 2003 12:28:27 -0000 1.1
+++ ProgressObject.java 4 Sep 2003 05:41:21 -0000 1.2
@@ -63,25 +63,94 @@
import javax.enterprise.deploy.spi.exceptions.OperationUnsupportedException;
/**
+ * The ProgressObject interface tracks and reports the progress of the
+ * deployment activities: distribute, start, stop, undeploy.
+ *
+ * This class has an <i>optional</i> cancel method. The support of the
cancel
+ * function can be tested by the isCancelSupported method.
+ *
+ * The ProgressObject structure allows the user the option of polling for
+ * status or to provide a callback.
*
* @version $Revision$ $Date$
*/
public interface ProgressObject {
+ /**
+ * Retrieve the status of this activity.
+ *
+ * @return An object containing the status information.
+ */
public DeploymentStatus getDeploymentStatus();
+ /**
+ * Retrieve the list of TargetModuleIDs successfully processed or created
+ * by the associated DeploymentManager operation.
+ *
+ * @return a list of TargetModuleIDs.
+ */
public TargetModuleID[] getResultTargetModuleIDs();
+ /**
+ * Return the ClientConfiguration object associated with the
+ * TargetModuleID.
+ *
+ * @return ClientConfiguration for a given TargetModuleID or
<tt>null</tt>
+ * if none exists.
+ */
public ClientConfiguration getClientConfiguration(TargetModuleID id);
+ /**
+ * Tests whether the vendor supports a cancel operation for this
+ * deployment action.
+ *
+ * @return <tt>true</tt> if this platform allows this action to be
+ * canceled.
+ */
public boolean isCancelSupported();
+ /**
+ * (optional) A cancel request on an in-process operation stops all
further
+ * processing of the operation and returns the environment to it original
+ * state before the operation was executed. An operation that has run to
+ * completion cannot be cancelled.
+ *
+ * @throws OperationUnsupportedException occurs when this optional
command
+ * is not supported by this implementation.
+ */
public void cancel() throws OperationUnsupportedException;
+ /**
+ * Tests whether the vendor supports a stop operation for the deployment
+ * action.
+ *
+ * @return <tt>true</tt> if this platform allows this action to be
+ * stopped.
+ */
public boolean isStopSupported();
+ /**
+ * (optional) A stop request on an in-process operation allows the
+ * operation on the current TargetModuleID to run to completion but does
+ * not process any of the remaining unprocessed TargetModuleID objects.
+ * The processed TargetModuleIDs must be returned by the method
+ * getResultTargetModuleIDs.
+ *
+ * @throws OperationUnsupportedException occurs when this optional
command
+ * is not supported by this implementation.
+ */
public void stop() throws OperationUnsupportedException;
+ /**
+ * Add a listener to receive progress events on deployment actions.
+ *
+ * @param pol the listener to receive events
+ */
public void addProgressListener(ProgressListener pol);
+ /**
+ * Remove a progress listener.
+ *
+ * @param pol the listener to remove
+ */
public void removeProgressListener(ProgressListener pol);
}
