deploymentmanager.html

来自「j2ee api,很好的api。我这现在有」· HTML 代码 · 共 951 行 · 第 1/4 页

<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dObj</CODE> - An object representing a J2EE deployable component.
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../../javax/enterprise/deploy/spi/exceptions/InvalidModuleException.html" title="class in javax.enterprise.deploy.spi.exceptions">InvalidModuleException</A></CODE> - The DeployableObject is an
                      unknown or unsupport component for this
                      configuration tool.</DL>
</DD>
</DL>
<HR>

<A NAME="distribute(javax.enterprise.deploy.spi.Target[], java.io.File, java.io.File)"><!-- --></A><H3>
distribute</H3>
<PRE>
public <A HREF="../../../../javax/enterprise/deploy/spi/status/ProgressObject.html" title="interface in javax.enterprise.deploy.spi.status">ProgressObject</A> <B>distribute</B>(<A HREF="../../../../javax/enterprise/deploy/spi/Target.html" title="interface in javax.enterprise.deploy.spi">Target</A>[]&nbsp;targetList,
                                 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html" title="class or interface in java.io">File</A>&nbsp;moduleArchive,
                                 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html" title="class or interface in java.io">File</A>&nbsp;deploymentPlan)
                          throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></PRE>
<DL>
<DD>The distribute method performs three tasks; it validates the
 deployment configuration data, generates all container specific 
 classes and interfaces, and moves the fully baked archive to 
 the designated deployment targets.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>targetList</CODE> - A list of server targets the user is specifying
                     this application be deployed to.<DD><CODE>moduleArchive</CODE> - The file name of the application archive
                      to be disrtibuted.<DD><CODE>deploymentPlan</CODE> - The XML file containing the runtime 
                       configuration information associated with
                       this application archive.
<DT><B>Returns:</B><DD>ProgressObject an object that tracks and reports the 
                       status of the distribution process.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></CODE> - is thrown when the method is
                    called when running in disconnected mode.</DL>
</DD>
</DL>
<HR>

<A NAME="distribute(javax.enterprise.deploy.spi.Target[], java.io.InputStream, java.io.InputStream)"><!-- --></A><H3>
distribute</H3>
<PRE>
public <A HREF="../../../../javax/enterprise/deploy/spi/status/ProgressObject.html" title="interface in javax.enterprise.deploy.spi.status">ProgressObject</A> <B>distribute</B>(<A HREF="../../../../javax/enterprise/deploy/spi/Target.html" title="interface in javax.enterprise.deploy.spi">Target</A>[]&nbsp;targetList,
                                 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A>&nbsp;moduleArchive,
                                 <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A>&nbsp;deploymentPlan)
                          throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></PRE>
<DL>
<DD>The distribute method performs three tasks; it validates the
 deployment configuration data, generates all container specific 
 classes and interfaces, and moves the fully baked archive to 
 the designated deployment targets.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>targetList</CODE> - A list of server targets the user is specifying
                     this application be deployed to.<DD><CODE>moduleArchive</CODE> - The input stream containing the application 
                      archive to be disrtibuted.<DD><CODE>deploymentPlan</CODE> - The input stream containing the deployment
                       configuration information associated with
                       this application archive.
<DT><B>Returns:</B><DD>ProgressObject an object that tracks and reports the 
                       status of the distribution process.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></CODE> - is thrown when the method is
                    called when running in disconnected mode.</DL>
</DD>
</DL>
<HR>

<A NAME="start(javax.enterprise.deploy.spi.TargetModuleID[])"><!-- --></A><H3>
start</H3>
<PRE>
public <A HREF="../../../../javax/enterprise/deploy/spi/status/ProgressObject.html" title="interface in javax.enterprise.deploy.spi.status">ProgressObject</A> <B>start</B>(<A HREF="../../../../javax/enterprise/deploy/spi/TargetModuleID.html" title="interface in javax.enterprise.deploy.spi">TargetModuleID</A>[]&nbsp;moduleIDList)
                     throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></PRE>
<DL>
<DD>Start the application running.  

 <p> Only the TargetModuleIDs which represent a root module
 are valid for being started. A root TargetModuleID has no parent.
 A TargetModuleID with a parent can not be individually started. 
 A root TargetModuleID module and all its child modules will be 
 started.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>moduleIDList</CODE> - A array of TargetModuleID objects 
                    representing the modules to be started.
<DT><B>Returns:</B><DD>ProgressObject an object that tracks and reports the 
                       status of the start operation.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></CODE> - is thrown when the method is
                    called when running in disconnected mode.</DL>
</DD>
</DL>
<HR>

<A NAME="stop(javax.enterprise.deploy.spi.TargetModuleID[])"><!-- --></A><H3>
stop</H3>
<PRE>
public <A HREF="../../../../javax/enterprise/deploy/spi/status/ProgressObject.html" title="interface in javax.enterprise.deploy.spi.status">ProgressObject</A> <B>stop</B>(<A HREF="../../../../javax/enterprise/deploy/spi/TargetModuleID.html" title="interface in javax.enterprise.deploy.spi">TargetModuleID</A>[]&nbsp;moduleIDList)
                    throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></PRE>
<DL>
<DD>Stop the application running.  

 <p> Only the TargetModuleIDs which represent a root module
 are valid for being stopped. A root TargetModuleID has no parent.
 A TargetModuleID with a parent can not be individually stopped. 
 A root TargetModuleID module and all its child modules will be 
 stopped.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>moduleIDList</CODE> - A array of TargetModuleID objects 
                    representing the modules to be stopped.
<DT><B>Returns:</B><DD>ProgressObject an object that tracks and reports the 
                       status of the stop operation.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></CODE> - is thrown when the method is
                    called when running in disconnected mode.</DL>
</DD>
</DL>
<HR>

<A NAME="undeploy(javax.enterprise.deploy.spi.TargetModuleID[])"><!-- --></A><H3>
undeploy</H3>
<PRE>
public <A HREF="../../../../javax/enterprise/deploy/spi/status/ProgressObject.html" title="interface in javax.enterprise.deploy.spi.status">ProgressObject</A> <B>undeploy</B>(<A HREF="../../../../javax/enterprise/deploy/spi/TargetModuleID.html" title="interface in javax.enterprise.deploy.spi">TargetModuleID</A>[]&nbsp;moduleIDList)
                        throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></PRE>
<DL>
<DD>Remove the application from the target server.  

 <p> Only the TargetModuleIDs which represent a root module
 are valid for undeployment. A root TargetModuleID has no parent.
 A TargetModuleID with a parent can not be undeployed. A root
 TargetModuleID module and all its child modules will be undeployed.
 The root TargetModuleID module and all its child modules must
 stopped before they can be undeployed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>moduleIDList</CODE> - An array of TargetModuleID objects representing
                   the root modules to be stopped.
<DT><B>Returns:</B><DD>ProgressObject an object that tracks and reports the 
                       status of the stop operation.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></CODE> - is thrown when the method is
                    called when running in disconnected mode.</DL>
</DD>
</DL>
<HR>

<A NAME="isRedeploySupported()"><!-- --></A><H3>
isRedeploySupported</H3>
<PRE>
public boolean <B>isRedeploySupported</B>()</PRE>
<DL>
<DD>This method designates whether this platform vendor provides
 application redeployment functionality. A value of true means
 it is supported.  False means it is not.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>A value of true means redeployment is supported by this
                   vendor's DeploymentManager.  False means it
                   is not.</DL>
</DD>
</DL>
<HR>

<A NAME="redeploy(javax.enterprise.deploy.spi.TargetModuleID[], java.io.File, java.io.File)"><!-- --></A><H3>
redeploy</H3>
<PRE>
public <A HREF="../../../../javax/enterprise/deploy/spi/status/ProgressObject.html" title="interface in javax.enterprise.deploy.spi.status">ProgressObject</A> <B>redeploy</B>(<A HREF="../../../../javax/enterprise/deploy/spi/TargetModuleID.html" title="interface in javax.enterprise.deploy.spi">TargetModuleID</A>[]&nbsp;moduleIDList,
                               <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html" title="class or interface in java.io">File</A>&nbsp;moduleArchive,
                               <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/File.html" title="class or interface in java.io">File</A>&nbsp;deploymentPlan)
                        throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A>,
                               <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></PRE>
<DL>
<DD>(optional)
 The redeploy method provides a means for updating currently
 deployed J2EE applications.  This is an optional method for
 vendor implementation.

 Redeploy replaces a currently deployed application with an
 updated version.  The runtime configuration information for 
 the updated application must remain identical to the application 
 it is updating.  

 When an application update is redeployed, all existing client
 connections to the original running application must not be disrupted; 
 new clients will connect to the application update.

 This operation is valid for TargetModuleIDs that represent a
 root module. A root TargetModuleID has no parent. A root
 TargetModuleID module and all its child modules will be redeployed.
 A child TargetModuleID module cannot be individually redeployed.
 The redeploy operation is complete only when this action for 
 all the modules has completed.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>moduleIDList</CODE> - An array of designators of the applications
                      to be updated.<DD><CODE>moduleArchive</CODE> - The file name of the application archive
                      to be disrtibuted.<DD><CODE>deploymentPlan</CODE> - The deployment configuration information
                       associated with this application archive.
<DT><B>Returns:</B><DD>ProgressObject an object that tracks and reports the
                       status of the redeploy operation.
<DT><B>Throws:</B>
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></CODE> - is thrown when the method is
                    called when running in disconnected mode.
<DD><CODE><A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A></CODE> - this optional command
         is not supported by this implementation.</DL>
</DD>
</DL>
<HR>

<A NAME="redeploy(javax.enterprise.deploy.spi.TargetModuleID[], java.io.InputStream, java.io.InputStream)"><!-- --></A><H3>
redeploy</H3>
<PRE>
public <A HREF="../../../../javax/enterprise/deploy/spi/status/ProgressObject.html" title="interface in javax.enterprise.deploy.spi.status">ProgressObject</A> <B>redeploy</B>(<A HREF="../../../../javax/enterprise/deploy/spi/TargetModuleID.html" title="interface in javax.enterprise.deploy.spi">TargetModuleID</A>[]&nbsp;moduleIDList,
                               <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A>&nbsp;moduleArchive,
                               <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/io/InputStream.html" title="class or interface in java.io">InputStream</A>&nbsp;deploymentPlan)
                        throws <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/UnsupportedOperationException.html" title="class or interface in java.lang">UnsupportedOperationException</A>,
                               <A HREF="http://java.sun.com/j2se/1.4/docs/api/java/lang/IllegalStateException.html" title="class or interface in java.lang">IllegalStateException</A></PRE>
<DL>
<DD>(optional)
 The redeploy method provides a means for updating currently
 deployed J2EE applications.  This is an optional method for
 vendor implementation.

 Redeploy replaces a currently deployed application with an
 updated version.  The runtime configuration information for 
 the updated application must remain identical to the application 
 it is updating.

 When an application update is redeployed, all existing client
 connections to the original running application must not be disrupted; 
 new clients will connect to the application update.

 This operation is valid for TargetModuleIDs that represent a
 root module. A root TargetModuleID has no parent. A root
 TargetModuleID module and all its child modules will be redeployed.
 A child TargetModuleID module cannot be individually redeployed.
 The redeploy operation is complete only when this action for 
 all the modules has completed.