Package weblogic.management.runtime

Interface DeployerRuntimeMBean

All Superinterfaces:

javax.management.DynamicMBean, javax.management.MBeanRegistration, javax.management.NotificationBroadcaster, RuntimeMBean, WebLogicMBean

@Deprecated
public interface DeployerRuntimeMBean
extends RuntimeMBean

Deprecated.

9.0.0.0 Replaced by WebLogicDeploymentManager

This MBean is the user API for initiating deployment requests and exists only on an Administration Server. To access this MBean, use DeployerRuntime.getDeployerRuntime().

The deployment methods in this MBean provide access to the two-phase deployment protocol. This protocol is only supported on WebLogic Server 7.x servers and later. If no target servers in an activate request are known to be pre-release 7 servers, then the two-phase protocol is used. Otherwise the deployment will use the WebLogic Server 6.x deployment protocol, even if some target servers are at release 7.

The deployment process involves a number of state changes: start<-->staged<-->prepared<-->active. The methods in this MBean provide the means for changing the state of an application, as follows:

activate: places application in active state from any other state

deactivate: places application in prepared state from active state

unprepare: places application in staged state from active and prepared state

remove: places application in start state from any other state

Activating An Application

The basic process of deploying an application is shown in the following example:

DeployerRuntimeMBean deployer = getDeployerRuntime(userName, password, adminURL);
try {
DeploymentTaskRuntimeMBean task = deployer.activate(sourceFile,appName,taging,info,id);
} catch (ManagementException me) {
System.out.println("Deployment failed: "+me.getMessage());
}

In this example, sourceFile is the path to the application. If the application is an EAR, then sourceFile would name the EAR archive or the root directory if it is not archived. Similarly, if the application is not an EAR, but a standalone module (web application or EJB), the sourceFile argument would be the path to the module archive or directory.

The sourceFile argument can be null, indicating that this is a redeployment and that the source is unchanged from a previous deployment.

The appName argument is the name to be given to the application. If this is a new deployment, an ApplicationMBean is created. For redeployments, an existing ApplicationMBean with appName is used as the application's configured state.

The info argument is a DeploymentData object which is used to qualify the deployment in terms of targets of the deployment and an optional list of files which are to be refreshed during a redeploy.

The staging argument is used to specify whether the application is to be staged to the target servers. This argument may be null (use ServerTemplateMBean.getStagingMode()), "stage", or "nostage". Staging is the process of uploading the application file to the target servers' staging area, defined in ServerTemplateMBean.getStagingDirectoryName().

The id argument allows the caller to name the deployment task. Care should be taken here as the tag must be unique. The recommendation is to generally use null for this argument, allowing the system to generate a unique tag.

The deployment process runs asynchronously to the invoker; it will initiate the task then return the DeploymentTaskRuntimeMBean object representing the task to the client. This object may be used to track status of the task. If the client wants to wait until the task completes then the following is a basic method for doing this.

while (task.isRunning()) {
try {
Thread.sleep(oneSecond);
} catch (InterruptedException ie) {}
}

Cancelling A Deployment

Note that a task will not complete until all targets have either completed the deployment or failed. If one of the targets is inactive, the task will remain active until the server starts or the task is cancelled. Cancelling a deployment task is accomplished as follows:

if (task.isRunning()) {
try {
task.cancel();
} catch (Exception e) {}
}

Targeting Specific Servers

The following examples show how to be more specific when targeting a deployment.

DeploymentData info = new DeploymentData();

// adds server1 as target for all modules in app

info.addTarget(server1,null);
String[] mods = { "web-module","ejb" };

// adds server2 as target for modules web-module and ejb

info.addTarget(server2,mods);
deployer.activate(sourceFile, appName, info, null, null);

// refreshes the hello.jsp file on all currently targeted servers.
// The "jsps" directory is relative to the root of the application.

String[] files = { "jsps/hello.jsp" };
DeploymentData info = new DeploymentData(files);
deployer.activate(null, appName, null, info, null);


Deactivating An Application

To deactivate an application is to suspend it. The application files remain staged on the target servers and can be reactivated without restaging. It should be noted that deactivating an application does not unload any of its classes. To do so requires an unprepare operation (see below). The following example show appName being deactivated, then subsequently reactivated on all configured servers.

deployer.deactivate(appName, null, null);
. . .
deployer.activate(null, appName, null, null, null);


Unpreparing An Application

To unprepare an application is to suspend and unload it. The application files remain staged on the target servers and any relevant classes are unloaded. If the application is to be reactivated with new class files, unprepare is the correct approach, rather than deactivate. The following example shows appName being unprepared, then subsequently reactivated on all configured servers.

deployer.unprepare(appName, null, null);
. . .
deployer.activate(sourceFile, appName, null, null, null);

Removing An Application

Removing an application involves deactivation, unstaging and possible removal of the application. After removing an application from a Managed Server, it is deconfigured from that server. If no servers remain targeted by the application, the entire configuration of the application is removed. Removal does not touch the application source, but will remove staged copies of the application.

// this completely removes an application from the domain configuration

deployer.remove(appName, null, null);

Tracking Deployment Status

Once initiated, a deployment task can be monitored via notifications or polling. Use of notifications relies on JMX Notifications on the relevant ApplicationMBean and is accomplished as follows:

package examples.deploy;
import java.io.Serializable;
import javax.management.MBeanServer;
import javax.management.Notification;
import javax.management.NotificationFilter;
import weblogic.management.DeploymentNotification;
import weblogic.management.Helper;
import weblogic.management.MBeanHome;
import weblogic.management.RemoteNotificationListener;
import weblogic.management.configuration.ApplicationMBean;
import weblogic.management.deploy.DeploymentData;
import weblogic.management.deploy.DeployerRuntime;
import weblogic.management.runtime.DeployerRuntimeMBean;
import weblogic.management.runtime.DeploymentTaskRuntimeMBean;

//This example activates an application and prints the resulting
// notifications generated during the processing of the deployment.
// The args passed to this program are:
// arg1: userid
// arg2: password
// arg3: admin URL
// arg4: app name
// arg5: app source
// arg6: target server

public class Activater implements Serializable {

private static String userid;
private static String password;
private static String url;
private static String name;
private static String source;
private static String server;

void deploy() {
try {

// Get access to MBeanHome

MBeanHome home = Helper.getAdminMBeanHome(userid, password, url);

// Get the deployer

DeployerRuntimeMBean deployer = DeployerRuntime.getDeployerRuntime(home);

// Build the DeploymentData object

DeploymentData info = new DeploymentData();
info.addTarget(server, null);

// Create the deployment task. Last arg indicates to just
// create the task, but not initiate it

DeploymentTaskRuntimeMBean task = deployer.activate(source,name,null,info,null,false);

// Register for notifications

ApplicationMBean app = task.getDeploymentObject();
MBeanServer mBeanServer = home.getMBeanServer();
mBeanServer.addNotificationListener( app.getObjectName(),new DeployListener(),new DeployFilter(),null );

// Start the task

task.start();
System.out.println(task.getDescription());

// wait until finished

while (task.isRunning()) {
try {
Thread.sleep(1000);
} catch (InterruptedException ie) {
System.out.println(task.getStatus());
}
}
} catch (Exception e) {
System.out.println(e.getMessage());
}
}

public static void main(String[] argv) throws Exception {
if (argv.length == 6) {
userid = argv[0];
password = argv[1];
url = argv[2];
name = argv[3];
source = argv[4];
server = argv[5];
Activater activater = new Activater();
activater.deploy();
System.exit(0);
}
}

// Inner classes for handling notifications

class DeployListener implements RemoteNotificationListener {

public void handleNotification(Notification notification,java.lang.Object handback)
{
System.out.println( notification.getMessage() );
}
};

// Inner class for filtering notifications

class DeployFilter implements NotificationFilter, Serializable {

public boolean isNotificationEnabled( Notification n )
{
return ( n instanceof DeploymentNotification );
}

}
}

Access limited to the following security roles:

Deployer

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	DEPLOYER_NAME	Deprecated. Name of this singleton MBean.

Method Summary

Modifier and Type	Method	Description
DeploymentTaskRuntimeMBean	activate(java.lang.String source, java.lang.String name, java.lang.String stagingMode, DeploymentData info, java.lang.String id)	Deprecated. 8.1.0.0 Replaced by deploy(java.lang.String, java.lang.String, java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String) or redeploy(java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String)
DeploymentTaskRuntimeMBean	activate(java.lang.String source, java.lang.String name, java.lang.String stagingMode, DeploymentData info, java.lang.String id, boolean startTask)	Deprecated. 8.1.0.0 Replaced by deploy(java.lang.String, java.lang.String, java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String) or redeploy(java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String)
DeploymentTaskRuntimeMBean	appendToExtensionLoader(java.lang.String source, DeploymentData info, java.lang.String id, boolean startTask)	Deprecated. Distributes code source identified by source to the WebLogic extension loader directory of each targeted server and appends the code source to the running WebLogic extension class loader.
DeploymentTaskRuntimeMBean	deactivate(java.lang.String name, DeploymentData info, java.lang.String id)	Deprecated. 8.1.0.0 Replaced by stop(java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String)
DeploymentTaskRuntimeMBean	deactivate(java.lang.String name, DeploymentData info, java.lang.String id, boolean startTask)	Deprecated. 8.1.0.0 Replaced by stop(java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String)
DeploymentTaskRuntimeMBean	deploy(java.lang.String source, java.lang.String name, java.lang.String stagingMode, DeploymentData info, java.lang.String id)	Deprecated. Deploys an application on its target(s).
DeploymentTaskRuntimeMBean	deploy(java.lang.String source, java.lang.String name, java.lang.String stagingMode, DeploymentData info, java.lang.String id, boolean startTask)	Deprecated. Same functionality as deploy(java.lang.String, java.lang.String, java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String) except that control is given back to the caller without actually initiating the task, when startTask is false.
DeploymentTaskRuntimeMBean	distribute(java.lang.String source, java.lang.String name, DeploymentData info, java.lang.String id)	Deprecated. Distributes application files on targets.
DeploymentTaskRuntimeMBean	distribute(java.lang.String source, java.lang.String name, DeploymentData info, java.lang.String id, boolean startTask)	Deprecated. Same functionality as distribute(String source, String, DeploymentData, String) except that control is given back to the caller without actually initiating the task, when startTask is false.
java.util.Map	getAvailabilityStatusForApplication(java.lang.String appName, boolean refreshCache)	Deprecated. 9.0.0.0 Replaced by AppRuntimeStateRuntimeMBean
java.util.Map	getAvailabilityStatusForComponent(ComponentMBean compMBean, boolean refreshCache)	Deprecated. 9.0.0.0 Replaced by AppRuntimeStateRuntimeMBean
DeploymentTaskRuntimeMBean[]	getDeploymentTaskRuntimes()	Deprecated. Return the deployment task runtime MBeans.
DeploymentTaskRuntimeMBean[]	list()	Deprecated. Return array of all known deployment tasks.
DeploymentTaskRuntimeMBean	query(java.lang.String id)	Deprecated. Locates a deployment task based on the deployment ID.
DeploymentTaskRuntimeMBean	redeploy(java.lang.String name, DeploymentData info, java.lang.String id)	Deprecated. Redeploys an application on its target(s).
DeploymentTaskRuntimeMBean	redeploy(java.lang.String name, DeploymentData info, java.lang.String id, boolean startTask)	Deprecated. Same functionality as redeploy(String, DeploymentData, String) except that control is given back to the caller without actually initiating the task, when startTask is false.
DeploymentTaskRuntimeMBean	remove(java.lang.String name, DeploymentData info, java.lang.String id)	Deprecated. 8.1.0.0 Replaced by undeploy(java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String)
DeploymentTaskRuntimeMBean	remove(java.lang.String name, DeploymentData info, java.lang.String id, boolean startTask)	Deprecated. 8.1.0.0 Replaced by undeploy(java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String)
DeploymentTaskRuntimeMBean	start(java.lang.String name, DeploymentData info, java.lang.String id)	Deprecated. Starts an already distributed application on its target(s).
DeploymentTaskRuntimeMBean	start(java.lang.String name, DeploymentData info, java.lang.String id, boolean startTask)	Deprecated. Same functionality as start(String, DeploymentData, String) except that control is given back to the caller without actually initiating the task, when startTask is false.
DeploymentTaskRuntimeMBean	stop(java.lang.String name, DeploymentData info, java.lang.String id)	Deprecated. Stops an application on its target(s).
DeploymentTaskRuntimeMBean	stop(java.lang.String name, DeploymentData info, java.lang.String id, boolean startTask)	Deprecated. Same functionality as stop(String, DeploymentData, String) except that control is given back to the caller without actually initiating the task, when startTask is false.
DeploymentTaskRuntimeMBean	undeploy(java.lang.String name, DeploymentData info, java.lang.String id)	Deprecated. Undeploys an application on its target(s).
DeploymentTaskRuntimeMBean	undeploy(java.lang.String name, DeploymentData info, java.lang.String id, boolean startTask)	Deprecated. Same functionality as undeploy(String, DeploymentData, String) except that control is given back to the caller without actually initiating the task, when startTask is false.
DeploymentTaskRuntimeMBean	unprepare(java.lang.String name, DeploymentData info, java.lang.String id)	Deprecated. 8.1.0.0 Replaced by stop(java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String)
DeploymentTaskRuntimeMBean	unprepare(java.lang.String name, DeploymentData info, java.lang.String id, boolean startTask)	Deprecated. 8.1.0.0 Replaced by stop(java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String)

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, invoke, setAttribute, setAttributes

Methods inherited from interface javax.management.MBeanRegistration

postDeregister, postRegister, preRegister

Methods inherited from interface javax.management.NotificationBroadcaster

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from interface weblogic.management.runtime.RuntimeMBean

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setName, setParent

Field Detail

DEPLOYER_NAME

static final java.lang.String DEPLOYER_NAME

Deprecated.

Name of this singleton MBean.

See Also:

Constant Field Values

Method Detail

activate

@Deprecated
DeploymentTaskRuntimeMBean activate(java.lang.String source,
                                    java.lang.String name,
                                    java.lang.String stagingMode,
                                    DeploymentData info,
                                    java.lang.String id)
                             throws ManagementException

Deprecated.

8.1.0.0 Replaced by deploy(java.lang.String, java.lang.String, java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String) or redeploy(java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String)

Activate a deployment. The deployment is extended to the relevant Java EE containers and subsystems. An ApplicationMBean is created if necessary and initialized prior to initiating the deployment for new deployments. If the application is already configured, it is expected to be correctly defined. Activate covers new deployments, redeployments and refreshes.

If the source argument is a valid path to an EAR or module, the application files will be distributed as necessary to the target servers. If the source argument is null, then the application must already be configured with a valid path.

The name argument must always be specified (not null). If there is already an application configured with this name, then the deployment will be based on that application. Otherwise, this is a new deployment and an ApplicationMBean will be created and fully configured based on the application descriptors found in the archive or directory named by the source argument. If this is a new deployment, the source argument cannot be null.

The stagingMode argument can be used to override the staging attribute of the targeted servers. If this argument is null, the application will be staged to each server if that server is configured to be staged. If stagingMode is "stage" or "nostage", then the application will be staged or not staged, respectively, to each server, regardless of the server's configuration. If the staging mode is "external_stage", the application files are not staged by the server, rather the user is expected to place them in the staging area.

The info argument is used to qualify the deployment. If null, the deployment will apply to the application's configured target servers. If info is not null, then it names a list of servers, each of which can be further qualified by module names. If a named target is not already configured for this application, it will be added as a target to the appropriate components.

The info argument can also specify a list of files and directories. This supports application refreshes. When a file list is defined in the info object, the deployment will cause those files to be redistributed to the target servers. The file paths must be relative to the application source. If the application is an archive, the entire archive is redistributed, otherwise only the named files are distributed. Note that if the application targets release 6.x servers, there is no guarantee that only the files listed are redeployed.

The ID argument is used to specify the identifier for the resulting task. If null, the system will generate the ID. If not null, then the value must be unique across all existing deployment tasks.

Parameters:

source - is the path to the application. If null, the configured path is used.

name - is the configured name of the application.

stagingMode - the value that will be set on the ApplicationMBean for this deployment "stage", "external_stage","nostage", or null which implies use the servers stagingMode value.

info - describes the details of the deployment.

id - to use for tracking. Use null to allow system to generate.

Returns:

a DeploymentTaskRuntimeMBean that is used to track the request.

Throws:

ManagementException - if the request is rejected.

activate

@Deprecated
DeploymentTaskRuntimeMBean activate(java.lang.String source,
                                    java.lang.String name,
                                    java.lang.String stagingMode,
                                    DeploymentData info,
                                    java.lang.String id,
                                    boolean startTask)
                             throws ManagementException

Deprecated.

8.1.0.0 Replaced by deploy(java.lang.String, java.lang.String, java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String) or redeploy(java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String)

Same functionality as activate(String, String, String, DeploymentData, String) except that control is given back to the caller without actually initiating the task, when startTask is false. The client must then invoke the DeploymentTaskRuntimeMBean.start() method to complete the activation process. This is most useful when the client is interested in receiving notifications of the task's progress.

Parameters:

source -

name -

stagingMode -

info -

id -

startTask -

Throws:

ManagementException

deactivate

@Deprecated
DeploymentTaskRuntimeMBean deactivate(java.lang.String name,
                                      DeploymentData info,
                                      java.lang.String id)
                               throws ManagementException

Deprecated.

8.1.0.0 Replaced by stop(java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String)

Deactivate a deployment. This suspends the services offered by the deployment and removes it from the relevant Java EE containers. The deployment will remain in the staging area and prepared following deactivation.

The info parameter is used to define the specific targets the deactivation applies to. If any targets are specified in the info object, they will be removed from the application configuration. If info object does not specify any targets, then the deactivation will apply to all targets configured for the application. In this scenario, the configured targets are not removed from the configuration. Rather, the application is configured as undeployed.

Parameters:

name - is the configured name of the application.

info - describes the details of the deployment. Null interpreted to deactivate the application on all servers, retaining targets.

id - to use for tracking. If null, a system generated id is used.

Returns:

a DeploymentTaskRuntimeMBean that is used to track the request

Throws:

ManagementException - if the request is rejected.

deactivate

@Deprecated
DeploymentTaskRuntimeMBean deactivate(java.lang.String name,
                                      DeploymentData info,
                                      java.lang.String id,
                                      boolean startTask)
                               throws ManagementException

Deprecated.

8.1.0.0 Replaced by stop(java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String)

Same functionality as deactivate(String, DeploymentData, String) except that control is given back to the caller without actually initiating the task, when startTask is false. The client must invoke the DeploymentTaskRuntimeMBean.start() method to complete the deactivation process. This is most useful when the client is interested in receiving notifications of the task's progress.

Parameters:

name -

info -

id -

startTask -

Throws:

ManagementException

remove

@Deprecated
DeploymentTaskRuntimeMBean remove(java.lang.String name,
                                  DeploymentData info,
                                  java.lang.String id)
                           throws ManagementException

Deprecated.

8.1.0.0 Replaced by undeploy(java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String)

Removes a deployment. This results in the application being deactivated and deconfigured from the target servers. Staged files are removed from the target server if they were staged when first deployed. If no targets are specified in the info object, or if the info object is null, the application is removed entirely from the domain.

Parameters:

name - is the configured name of the application to remove

info - describes the details of the deployment.

id - to use for tracking. If null, a system generated id is used.

Returns:

a DeploymentTaskRuntimeMBean that is used to track the request

Throws:

ManagementException - if the request is rejected.

remove

@Deprecated
DeploymentTaskRuntimeMBean remove(java.lang.String name,
                                  DeploymentData info,
                                  java.lang.String id,
                                  boolean startTask)
                           throws ManagementException

Deprecated.

8.1.0.0 Replaced by undeploy(java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String)

Same functionality as remove(String, DeploymentData, String) except that control is given back to the caller without actually initiating the task, when startTask is false. The client must invoke the DeploymentTaskRuntimeMBean.start() method to complete the remove process. This is most useful when the client is interested in receiving notifications of the task's progress.

Parameters:

name -

info -

id -

startTask -

Throws:

ManagementException

unprepare

@Deprecated
DeploymentTaskRuntimeMBean unprepare(java.lang.String name,
                                     DeploymentData info,
                                     java.lang.String id)
                              throws ManagementException

Deprecated.

8.1.0.0 Replaced by stop(java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String)

Deactivate and unload a deployment. This results in the application being deactivated and classes are unloaded from the target servers. Staged files are not removed from the target server if they were staged when first deployed. If no targets are specified in the info object, or if the info object is null, the application is removed entirely from the domain.

Parameters:

name - is the configured name of the application to unprepare

info - describes the details of the deployment.

id - to use for tracking. If null, a system generated id is used.

Returns:

a DeploymentTaskRuntimeMBean that is used to track the request

Throws:

ManagementException - if the request is rejected.

unprepare

@Deprecated
DeploymentTaskRuntimeMBean unprepare(java.lang.String name,
                                     DeploymentData info,
                                     java.lang.String id,
                                     boolean startTask)
                              throws ManagementException

Deprecated.

8.1.0.0 Replaced by stop(java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String)

Same functionality as unprepare(String, DeploymentData, String) except that control is given back to the caller without actually initiating the task, when startTask is false. The client must invoke the DeploymentTaskRuntimeMBean.start() method to complete the process. This is most useful when the client is interested in receiving notifications of the task's progress.

Parameters:

name -

info -

id -

startTask -

Throws:

ManagementException

distribute

DeploymentTaskRuntimeMBean distribute(java.lang.String source,
                                      java.lang.String name,
                                      DeploymentData info,
                                      java.lang.String id)
                               throws ManagementException

Deprecated.

Distributes application files on targets. This results in the application being copied to the staging area of a target.

Parameters:

source - is the path to the application files

name - is the configured name of the application to distribute

info - contains target information.

id - to use for tracking. If null, a system generated id is used.

Returns:

a DeploymentTaskRuntimeMBean that is used to track the request

Throws:

ManagementException - if the request is rejected.

distribute

DeploymentTaskRuntimeMBean distribute(java.lang.String source,
                                      java.lang.String name,
                                      DeploymentData info,
                                      java.lang.String id,
                                      boolean startTask)
                               throws ManagementException

Deprecated.

Same functionality as distribute(String source, String, DeploymentData, String) except that control is given back to the caller without actually initiating the task, when startTask is false. The client must invoke the DeploymentTaskRuntimeMBean.start() method to complete the process. This is most useful when the client is interested in receiving notifications of the task's progress.

Parameters:

source -

name -

info - contains target information.

id -

startTask -

Throws:

ManagementException

appendToExtensionLoader

DeploymentTaskRuntimeMBean appendToExtensionLoader(java.lang.String source,
                                                   DeploymentData info,
                                                   java.lang.String id,
                                                   boolean startTask)
                                            throws ManagementException

Deprecated.

Distributes code source identified by source to the WebLogic extension loader directory of each targeted server and appends the code source to the running WebLogic extension class loader. Control is given back to the caller without actually initiating the task, when startTask is false. The client must invoke the DeploymentTaskRuntimeMBean.start() method to complete the process. This is most useful when the client is interested in receiving notifications of the task's progress.

Parameters:

source -

info - contains target information.

id -

startTask -

Throws:

ManagementException

start

DeploymentTaskRuntimeMBean start(java.lang.String name,
                                 DeploymentData info,
                                 java.lang.String id)
                          throws ManagementException

Deprecated.

Starts an already distributed application on its target(s). This results in the application being prepared and activated on its target(s).

Parameters:

name - is the configured name of the application to start

info - contains target information.

id - to use for tracking. If null, a system generated id is used.

Returns:

a DeploymentTaskRuntimeMBean that is used to track the request

Throws:

ManagementException - if the request is rejected.

Access limited to the following security roles:

Operator

start

DeploymentTaskRuntimeMBean start(java.lang.String name,
                                 DeploymentData info,
                                 java.lang.String id,
                                 boolean startTask)
                          throws ManagementException

Deprecated.

Same functionality as start(String, DeploymentData, String) except that control is given back to the caller without actually initiating the task, when startTask is false. The client must invoke the DeploymentTaskRuntimeMBean.start() method to complete the process. This is most useful when the client is interested in receiving notifications of the task's progress.

Parameters:

name -

info - contains target information.

id -

startTask -

Throws:

ManagementException

Access limited to the following security roles:

Operator

stop

DeploymentTaskRuntimeMBean stop(java.lang.String name,
                                DeploymentData info,
                                java.lang.String id)
                         throws ManagementException

Deprecated.

Stops an application on its target(s). This results in an application becoming unavailable for the clients.

Parameters:

name - is the configured name of the application to start

info - contains target information.

id - to use for tracking. If null, a system generated id is used.

Returns:

a DeploymentTaskRuntimeMBean that is used to track the request

Throws:

ManagementException - if the request is rejected.

Access limited to the following security roles:

Operator

stop

DeploymentTaskRuntimeMBean stop(java.lang.String name,
                                DeploymentData info,
                                java.lang.String id,
                                boolean startTask)
                         throws ManagementException

Deprecated.

Same functionality as stop(String, DeploymentData, String) except that control is given back to the caller without actually initiating the task, when startTask is false. The client must invoke the DeploymentTaskRuntimeMBean.start() method to complete the process. This is most useful when the client is interested in receiving notifications of the task's progress.

Parameters:

name -

info - contains target information.

id -

startTask -

Throws:

ManagementException

Access limited to the following security roles:

Operator

deploy

DeploymentTaskRuntimeMBean deploy(java.lang.String source,
                                  java.lang.String name,
                                  java.lang.String stagingMode,
                                  DeploymentData info,
                                  java.lang.String id)
                           throws ManagementException

Deprecated.

Deploys an application on its target(s). This results in the application being distributed, prepared and activated on specified target(s). The name argument must always be specified (not null). If there is already an application configured with this name, then the deployment will be based on that application. Otherwise, this is a new deployment and an ApplicationMBean will be created and fully configured based on the application descriptors found in the archive or directory named by the source argument. If this is a new deployment, the source argument cannot be null.

The stagingMode argument can be used to override the staging attribute of the targeted servers. If this argument is null, the application will be staged to each server if that server is configured to be staged. If stagingMode is "stage" or "nostage" then the application will be staged or not staged, respectively, to each server, regardless of the server's configuration. If the staging mode is "external_stage", the application files are not staged by the server, rather the user is expected to place them in the staging area.

Parameters:

source - is the path to the application files

name - is the configured name of the application to distribute

info - contains target information. It names a list of target servers, each of which can be further qualified by module names.

id - to use for tracking. If null, a system generated id is used.

stagingMode -

Returns:

a DeploymentTaskRuntimeMBean that is used to track the request

Throws:

ManagementException - if the request is rejected.

deploy

DeploymentTaskRuntimeMBean deploy(java.lang.String source,
                                  java.lang.String name,
                                  java.lang.String stagingMode,
                                  DeploymentData info,
                                  java.lang.String id,
                                  boolean startTask)
                           throws ManagementException

Deprecated.

Same functionality as deploy(java.lang.String, java.lang.String, java.lang.String, weblogic.management.deploy.DeploymentData, java.lang.String) except that control is given back to the caller without actually initiating the task, when startTask is false. The client must invoke the DeploymentTaskRuntimeMBean.start() method to complete the process. This is most useful when the client is interested in receiving notifications of the task's progress.

Parameters:

source -

name -

stagingMode -

info -

id -

startTask -

Throws:

ManagementException

redeploy

DeploymentTaskRuntimeMBean redeploy(java.lang.String name,
                                    DeploymentData info,
                                    java.lang.String id)
                             throws ManagementException

Deprecated.

Redeploys an application on its target(s). This results in the redeploy of an entire application on its target(s). Redeploy results in redistribution of the application if staging mode is "stage". Redeploy can also be used for partial redeployment by specifying a list of files.

The info argument is used to qualify the deployment. If null, the deployment will apply to the application's configured target servers. If info is not null, then it names a list of servers, each of which can be further qualified by module names. If a named target is not already configured for this application, it will be added as a target to the appropriate components.

Parameters:

name - is the configured name of the application to distribute

info - contains target information.

id - to use for tracking. If null, a system generated id is used.

Returns:

a DeploymentTaskRuntimeMBean that is used to track the request

Throws:

ManagementException - if the request is rejected.

redeploy

DeploymentTaskRuntimeMBean redeploy(java.lang.String name,
                                    DeploymentData info,
                                    java.lang.String id,
                                    boolean startTask)
                             throws ManagementException

Deprecated.

Same functionality as redeploy(String, DeploymentData, String) except that control is given back to the caller without actually initiating the task, when startTask is false. The client must invoke the DeploymentTaskRuntimeMBean.start() method to complete the process. This is most useful when the client is interested in receiving notifications of the task's progress.

Parameters:

name -

info -

id -

startTask -

Throws:

ManagementException

undeploy

DeploymentTaskRuntimeMBean undeploy(java.lang.String name,
                                    DeploymentData info,
                                    java.lang.String id)
                             throws ManagementException

Deprecated.

Undeploys an application on its target(s). This results in deactivating and removing an application on its target(s). This is the exact reverse of deploy().

Parameters:

name - is the configured name of the application to distribute

info - contains target information.

id - to use for tracking. If null, a system generated id is used.

Returns:

a DeploymentTaskRuntimeMBean that is used to track the request

Throws:

ManagementException - if the request is rejected.

undeploy

DeploymentTaskRuntimeMBean undeploy(java.lang.String name,
                                    DeploymentData info,
                                    java.lang.String id,
                                    boolean startTask)
                             throws ManagementException

Deprecated.

Same functionality as undeploy(String, DeploymentData, String) except that control is given back to the caller without actually initiating the task, when startTask is false. The client must invoke the DeploymentTaskRuntimeMBean.start() method to complete the process. This is most useful when the client is interested in receiving notifications of the task's progress.

Parameters:

name - is the configured name of the application to distribute

info - describes the details of the deployment.

id - to use for tracking. If null, a system generated id is used.

startTask -

Returns:

a DeploymentTaskRuntimeMBean that is used to track the request

Throws:

ManagementException - if the request is rejected.

query

DeploymentTaskRuntimeMBean query(java.lang.String id)

Deprecated.

Locates a deployment task based on the deployment ID.

Parameters:

id - is the id to query

Returns:

the DeploymentTaskRuntimeMBean for the task. Returns null if the task could not be found.

Access limited to the following security roles:

Operator

list

DeploymentTaskRuntimeMBean[] list()

Deprecated.

Return array of all known deployment tasks.

getDeploymentTaskRuntimes

DeploymentTaskRuntimeMBean[] getDeploymentTaskRuntimes()

Deprecated.

Return the deployment task runtime MBeans.

getAvailabilityStatusForApplication

@Deprecated
java.util.Map getAvailabilityStatusForApplication(java.lang.String appName,
                                                  boolean refreshCache)
                                           throws javax.management.InstanceNotFoundException

Deprecated.

9.0.0.0 Replaced by AppRuntimeStateRuntimeMBean

Provides a map consisting of component names of the application and a map of availability status for each target of that component including any virtual hosts. The map corresponding to each component name consists of the component target name and the weblogic.management.TargetAvailabilityStatus object corresponding to that component target.

Throws:

javax.management.InstanceNotFoundException

getAvailabilityStatusForComponent

@Deprecated
java.util.Map getAvailabilityStatusForComponent(ComponentMBean compMBean,
                                                boolean refreshCache)
                                         throws javax.management.InstanceNotFoundException

Deprecated.

9.0.0.0 Replaced by AppRuntimeStateRuntimeMBean

Provides a map of availability status for each target of that component, including any virtual hosts. The map consist of the component target name and the TargetAvailabilityStatus object corresponding to that component target.

Throws:

javax.management.InstanceNotFoundException