KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jboss > enterprise > deploy > spi > status > JBoss30ProgressObject


1 package org.jboss.enterprise.deploy.spi.status;
2
3 import javax.enterprise.deploy.spi.*;
4 import javax.enterprise.deploy.spi.exceptions.OperationUnsupportedException JavaDoc;
5 import javax.enterprise.deploy.spi.status.*;
6
7 /**
8  * The ProgressObject interface tracks and reports the progress of the deployment activities, distribute, start, stop, undeploy. <p>
9  *
10  * This class has an <code> optional</code> cancel method. The support of the cancel function can be tested by the isCancelSupported method. </p> <p>
11  *
12  * The ProgressObject structure allows the user the option of polling for status or to provide a callback. </p>
13  *
14  * @author letiembl
15  * @created 15 avril 2002
16  */
17 public class JBoss30ProgressObject implements ProgressObject
18 {
19
20    /**
21     * Add a listener to receive Progress events on deployment actions.
22     *
23     * @param pol The feature to be added to the ProgressListener attribute
24     * @see ProgressEvent
25     */
26    public void addProgressListener(ProgressListener pol) { }
27
28
29
30    /**
31     * (optional) A cancel request on an in-process operation stops all further processing of the operation and returns the environment to it original state
32     * before the operation was executed. An operation that has run to completion cannot be cancelled.
33     *
34     * @throws OperationUnsupportedException this optional command is not supported by this implementation.
35     */
36    public void cancel() throws OperationUnsupportedException JavaDoc { }
37
38
39    /**
40     * Return the ClientConfiguration object associated with the TargetModuleID.
41     *
42     * @param id Description of Parameter
43     * @return ClientConfiguration for a given TargetModuleID or null if none exists.
44     */
45    public ClientConfiguration getClientConfiguration(TargetModuleID id)
46    {
47       return null;
48    }
49
50
51    /**
52     * Retrieve the status of this activity.
53     *
54     * @return An object containing the status information.
55     */
56    public DeploymentStatus getDeploymentStatus()
57    {
58       return null;
59    }
60
61
62    /**
63     * Retrieve the list of TargetModuleIDs successfully processed or created by the associated DeploymentManager operation.
64     *
65     * @return a list of TargetModuleIDs.
66     */
67    public TargetModuleID[] getResultTargetModuleIDs()
68    {
69       return null;
70    }
71
72
73
74    /**
75     * Tests whether the vendor supports a cancel opertation for deployment activities.
76     *
77     * @return <code>true</code> if canceling an activity is supported by this platform.
78     */
79    public boolean isCancelSupported()
80    {
81       return false;
82    }
83
84
85
86    /**
87     * Tests whether the vendor supports a stop opertation for deployment activities.
88     *
89     * @return <code>true</code> if canceling an activity is supported by this platform.
90     */
91    public boolean isStopSupported()
92    {
93       return false;
94    }
95
96
97
98    /**
99     * Remove a ProgressObject listener.
100     *
101     * @param pol Description of Parameter
102     * @see ProgressEvent
103     */
104    public void removeProgressListener(ProgressListener pol) { }
105
106
107
108    /**
109     * (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
110     * the remaining unprocessed TargetModuleID objects. The processed TargetModuleIDs must be returned by the method getResultTargetModuleIDs.
111     *
112     * @throws OperationUnsupportedException this optional command is not supported by this implementation.
113     */
114    public void stop() throws OperationUnsupportedException JavaDoc { }
115
116 }
117
118
Popular Tags