WebLogic Server 8.1 API Reference

weblogic.management.deploy
Class DeployerRuntime

java.lang.Object
  |
  +--javax.management.NotificationBroadcasterSupport
        |
        +--weblogic.management.internal.DynamicMBeanImpl
              |
              +--weblogic.management.runtime.RuntimeMBeanDelegate
                    |
                    +--weblogic.management.deploy.DeployerRuntime

public class DeployerRuntime

extends weblogic.management.runtime.RuntimeMBeanDelegate

implements DeployerRuntimeMBean

This class is the singleton deployer that exists on Admin Servers. It the the primary interface to all application deployment related tasks.

Author:

Copyright © 2002 BEA Systems, Inc. All Rights Reserved.

See Also:

Serialized Form

Fields inherited from class weblogic.management.internal.DynamicMBeanImpl

ADMIN, CONFIG, localizing, mbean, mbeanServer, mbeanType, name, NAME_ATTRIBUTE, objectName, parent, registered, RUNTIME, type

Method Summary

DeploymentTaskRuntimeMBean	deploy(java.lang.String source, java.lang.String name, java.lang.String stagingMode, DeploymentData info, java.lang.String id) deploy is essentially a wrapper around activate().
DeploymentTaskRuntimeMBean	deploy(java.lang.String source, java.lang.String name, java.lang.String stagingMode, DeploymentData info, java.lang.String id, boolean startIt) Same functionality as deploy(String, String, String, DeploymentData, String) except that control is given back to 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) Distributes the Application files to the target's staging area
DeploymentTaskRuntimeMBean	distribute(java.lang.String source, java.lang.String name, DeploymentData info, java.lang.String id, boolean startTask) Same functionality as #distribute(String, DeploymentData, String) except that control is given back to caller without actually initiating the task, when startTask is false.
static DeployerRuntimeMBean	getDeployerRuntime() Provides server side access to the DeployerRuntime singleton
static DeployerRuntimeMBean	getDeployerRuntime(MBeanHome home) Provides credentialed client access to the DeployerRuntime singleton.
static DeployerRuntimeMBean	getDeployerRuntime(java.lang.String user, java.lang.String pword, java.lang.String adminURL) Provides client access to the DeployerRuntime singleton.
DeploymentTaskRuntimeMBean	redeploy(java.lang.String name, DeploymentData info, java.lang.String id) Redeploys an already deployed application.
DeploymentTaskRuntimeMBean	redeploy(java.lang.String name, DeploymentData info, java.lang.String id, boolean startTask) Same functionality as redeploy(String, DeploymentData, String) except that control is given back to caller without actually initiating the task, when startTask is false.
DeploymentTaskRuntimeMBean	start(java.lang.String name, DeploymentData info, java.lang.String id) start will deploy an already distributed application
DeploymentTaskRuntimeMBean	start(java.lang.String name, DeploymentData info, java.lang.String id, boolean startTask) Same functionality as start(String, DeploymentData, String) except that control is given back to caller without actually initiating the task, when startTask is false.
DeploymentTaskRuntimeMBean	stop(java.lang.String name, DeploymentData info, java.lang.String id) Stop unprepares an already deployed application on target(s)
DeploymentTaskRuntimeMBean	stop(java.lang.String name, DeploymentData info, java.lang.String id, boolean startTask) Same functionality as start(String, DeploymentData, String) except that control is given back to caller without actually initiating the task, when startTask is false.

Methods inherited from class weblogic.management.internal.DynamicMBeanImpl

add, compareTo, copyFrom, disableNotifications, enableNotifications, ensureArgumentLocality, getAttribute, getAttributeInfo, getAttributes, getDefaultAttributeValue, getExtendedAttributeInfo, getExtendedOperationInfo, getLocalMBeanHome, getMBeanInfo, getMBeanType, getName, getObjectName, getParent, getSetAttributes, getType, getXAttributeInfo, invoke, invokeLocally, isAdmin, isCachingDisabled, isConfig, isRegistered, isRuntime, isSet, markAttributeModified, markAttributeModified, postDeregister, postRegister, preDeregister, preRegister, remove, sendNotification, setAttribute, setAttributes, setLocalMBeanHome, setName, setParent, setParent, setType, toString, unSet, valuesGet, valuesPut

Methods inherited from class javax.management.NotificationBroadcasterSupport

addNotificationListener, getNotificationInfo, removeNotificationListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

distribute

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

Distributes the Application files to the target's staging area

Specified by:

distribute in interface DeployerRuntimeMBean

Parameters:

source - location of source on admin server

name - application name

info - DeploymentData object

id - task id

Returns:

DeploymentTaskRuntimeMBean

Throws:

ManagementException -

distribute

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

Same functionality as #distribute(String, DeploymentData, String) except that control is given back to caller without actually initiating the task, when startTask is false.

Specified by:

distribute in interface DeployerRuntimeMBean

deploy

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

deploy is essentially a wrapper around activate(). deploy is same as activate.

Specified by:

deploy in interface DeployerRuntimeMBean

deploy

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

Same functionality as deploy(String, String, String, DeploymentData, String) except that control is given back to caller without actually initiating the task, when startTask is false.

Specified by:

deploy in interface DeployerRuntimeMBean

start

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

start will deploy an already distributed application

Specified by:

start in interface DeployerRuntimeMBean

Parameters:

name - Application name

info - DeploymentData object

id - deployment id for this request

Returns:

DeploymentTaskRuntimeMBean task that encapsulates deployment request

Throws:

ManagementException -

start

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

Same functionality as start(String, DeploymentData, String) except that control is given back to caller without actually initiating the task, when startTask is false.

Specified by:

start in interface DeployerRuntimeMBean

stop

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

Stop unprepares an already deployed application on target(s)

Specified by:

stop in interface DeployerRuntimeMBean

Parameters:

name - Application name

info - DeploymentData object

id - deployment id for this request

Returns:

DeploymentTaskRuntimeMBean task that encapsulates deployment request

Throws:

ManagementException -

stop

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

Same functionality as start(String, DeploymentData, String) except that control is given back to caller without actually initiating the task, when startTask is false.

Specified by:

stop in interface DeployerRuntimeMBean

redeploy

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

Redeploys an already deployed application.

Specified by:

redeploy in interface DeployerRuntimeMBean

Parameters:

name - Application name

info - DeploymentData object

id - deployment id for this request

Returns:

DeploymentTaskRuntimeMBean task that encapsulates deployment request

Throws:

ManagementException -

redeploy

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

Same functionality as redeploy(String, DeploymentData, String) except that control is given back to caller without actually initiating the task, when startTask is false.

Specified by:

redeploy in interface DeployerRuntimeMBean

getDeployerRuntime

public static DeployerRuntimeMBean getDeployerRuntime(java.lang.String user,
                                                      java.lang.String pword,
                                                      java.lang.String adminURL)
                                               throws java.lang.IllegalArgumentException,
                                                      javax.management.InstanceNotFoundException

Provides client access to the DeployerRuntime singleton.

Parameters:

user - is the userid to use for authentication

pword - is the password to use for authentication

adminURL - is the URL of the Admin Server

Returns:

the DeployerRuntime singleton

Throws:

javax.management.InstanceNotFoundException - Description of the Exception

java.lang.IllegalArgumentException - if unable to obtain context or contact the Admin Server

See Also:

getDeployerRuntime()

getDeployerRuntime

public static DeployerRuntimeMBean getDeployerRuntime(MBeanHome home)
                                               throws java.lang.IllegalArgumentException,
                                                      javax.management.InstanceNotFoundException

Provides credentialed client access to the DeployerRuntime singleton.

Parameters:

home - is the MBean home proxy from the admin server

Returns:

the DeployerRuntime singleton

Throws:

javax.management.InstanceNotFoundException - Description of the Exception

java.lang.IllegalArgumentException - if unable to obtain context or contact the Admin Server

See Also:

getDeployerRuntime()

getDeployerRuntime

public static DeployerRuntimeMBean getDeployerRuntime()

Provides server side access to the DeployerRuntime singleton

Returns:

the DeployerRuntime singleton.

See Also:

getDeployerRuntime(String, String, String)