|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.3) Part Number E41849-02 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AppDeploymentRuntimeMBean
This MBean provides deployment operations for an application. Currently only start and stop are supported. In the future, this MBean may be enhanced with operations to support deployment applications to the domain as well as extended WLS deployment features such as production redeployment and partial deployment of modules in an enterprise application.
Method Summary | |
---|---|
String |
getApplicationName()
The application's name. |
String |
getApplicationVersion()
The application's version identifier. |
String[] |
getModules()
The list of modules for the application. |
String |
getState(String target)
The state of the application for a target. |
DeploymentProgressObjectMBean |
redeploy()
Redeploy the application using the default options and configured targets. |
DeploymentProgressObjectMBean |
redeploy(String[] targets,
String plan,
Properties deploymentOptions)
Redeploy the application in the background for the targets specified with the options specified. |
DeploymentProgressObjectMBean |
start()
Start the application using the default options and configured targets. |
DeploymentProgressObjectMBean |
start(String[] targets,
Properties deploymentOptions)
Start the application in the background for the targets specified with the options specified. |
DeploymentProgressObjectMBean |
stop()
Stop the application using the default options and configured targets. |
DeploymentProgressObjectMBean |
stop(String[] targets,
Properties deploymentOptions)
Stop the application in the background for the targets specified with the options specified. |
DeploymentProgressObjectMBean |
undeploy()
Undeploy the application using the default options and configured targets. |
DeploymentProgressObjectMBean |
undeploy(String[] targets,
Properties deploymentOptions)
Undeploy the application in the background for the targets specified with the options specified. |
DeploymentProgressObjectMBean |
update(String[] targets,
String plan,
Properties deploymentOptions)
Allows for updating an application configuration using an changed deployment plan. |
Methods inherited from interface weblogic.management.WebLogicMBean |
---|
getMBeanInfo, getName, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent |
Methods inherited from interface javax.management.DynamicMBean |
---|
getAttribute, getAttributes, invoke, setAttribute, setAttributes |
Methods inherited from interface javax.management.MBeanRegistration |
---|
postDeregister, postRegister, preDeregister, preRegister |
Methods inherited from interface javax.management.NotificationBroadcaster |
---|
addNotificationListener, getNotificationInfo, removeNotificationListener |
Method Detail |
---|
String getApplicationName()
The application's name.
String getApplicationVersion()
The application's version identifier.
DeploymentProgressObjectMBean start() throws RuntimeException
Start the application using the default options and configured targets. This is a synchronous operation that returns when the start operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout
DeploymentProgressObjectMBean
An object that provides the
state of the start operation.
RuntimeExceptionm
- if the operation cannot be started
All other errors are reported via the returned
DeploymentProgressObjectMBean.
RuntimeException
DeploymentProgressObjectMBean start(String[] targets, Properties deploymentOptions) throws RuntimeException
Start the application in the background for the targets specified
with the options specified. This is an asynchronous operation that
returns immediately. The returned DeploymentProgressObjectMBean
can be used to determine when the operation is completed.
targets
- The targets on which to start the
application. This would be server names,
cluster names, or module names in a similar format to
weblogic.Deployer (i.e. module1@server1). If null, the application
will be started on all configured targets.deploymentOptions
- Allows for overriding the deployment options.
If null, default options will be used.
The values should all be of type
The keys,units and default values for options are
clusterDeploymentTimeout milliseconds 3600000,
gracefulIgnoreSessions boolean false,
gracefulProductionToAdmin boolean false,
retireGracefully boolean true,
retireTimeout seconds -1 (no timeout),
adminMode boolean false,
timeout milliseconds 0 (no timeout)
RuntimeException
- if the operation cannot be started
All other errors are reported via the returned
DeploymentProgressObjectMBean.DeploymentProgressObjectMBean stop() throws RuntimeException
Stop the application using the default options and configured targets. This is a synchronous operation that returns when the stop operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout
DeploymentProgressObjectMBean
An object that provides the
state of the stop operation.
RuntimeExceptionm
- if the operation cannot be started
All other errors are reported via the returned
DeploymentProgressObjectMBean.
RuntimeException
DeploymentProgressObjectMBean stop(String[] targets, Properties deploymentOptions) throws RuntimeException
Stop the application in the background for the targets specified
with the options specified. This is an asynchronous operation that
returns immediately. The returned DeploymentProgressObjectMBean
can be used to determine when the operation is completed.
targets
- The targets on which to stop the
application. This would be server names,
cluster names, or module names in a similar format to
weblogic.Deployer (i.e. module1@server1). If null, the application
will be stoped on all configured targets.deploymentOptions
- Allows for overriding the deployment options.
If null, default options will be used.
The values should all be of type
The keys,units and default values for options are
clusterDeploymentTimeout milliseconds 3600000,
gracefulIgnoreSessions boolean false,
gracefulProductionToAdmin boolean false,
retireGracefully boolean true,
retireTimeout seconds -1 (no timeout),
adminMode boolean false,
timeout milliseconds 0 (no timeout)
RuntimeException
- if the operation cannot be started
All other errors are reported via the returned
DeploymentProgressObjectMBean.DeploymentProgressObjectMBean undeploy() throws RuntimeException
Undeploy the application using the default options and configured targets. This is a synchronous operation that returns when the undeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout
DeploymentProgressObjectMBean
An object that provides the
state of the undeploy operation.
RuntimeExceptionm
- if the operation cannot be started
All other errors are reported via the returned
DeploymentProgressObjectMBean.
RuntimeException
DeploymentProgressObjectMBean undeploy(String[] targets, Properties deploymentOptions) throws RuntimeException
Undeploy the application in the background for the targets specified
with the options specified. This is an asynchronous operation that
returns immediately. The returned DeploymentProgressObjectMBean
can be used to determine when the operation is completed.
targets
- The targets on which to undeploy the
application. This would be server names,
cluster names, or module names in a similar format to
weblogic.Deployer (i.e. module1@server1). If null, the application
will be undeployed on all configured targets.deploymentOptions
- Allows for overriding the deployment options.
If null, default options will be used.
The values should all be of type
The keys,units and default values for options are
clusterDeploymentTimeout milliseconds 3600000,
gracefulIgnoreSessions boolean false,
gracefulProductionToAdmin boolean false,
retireGracefully boolean true,
retireTimeout seconds -1 (no timeout),
adminMode boolean false,
timeout milliseconds 0 (no timeout)
RuntimeException
- if the operation cannot be started
All other errors are reported via the returned
DeploymentProgressObjectMBean.DeploymentProgressObjectMBean redeploy() throws RuntimeException
Redeploy the application using the default options and configured targets. This is a synchronous operation that returns when the redeploy operation has completed. The default options are clusterDeploymentTimeout: 3600000 milliseconds, gracefulIgnoreSessions: false, gracefulProductionToAdmin: false, retireGracefully: true, retireTimeout: no timeout, adminMode: false, timeout: no timeout
DeploymentProgressObjectMBean
An object that provides the
state of the redeploy operation.
RuntimeExceptionm
- if the operation cannot be started
All other errors are reported via the returned
DeploymentProgressObjectMBean.
RuntimeException
DeploymentProgressObjectMBean redeploy(String[] targets, String plan, Properties deploymentOptions) throws RuntimeException
Redeploy the application in the background for the targets specified
with the options specified. This is an asynchronous operation that
returns immediately. The returned DeploymentProgressObjectMBean
can be used to determine when the operation is completed.
targets
- The targets on which to redeploy the
application. This would be server names,
cluster names, or module names in a similar format to
weblogic.Deployer (i.e. module1@server1). If null, the application
will be redeployed on all configured targets.plan
- The deployment plan for this application. May be null.deploymentOptions
- Allows for overriding the deployment options.
If null, default options will be used.
The values should all be of type
The keys,units and default values for options are
clusterDeploymentTimeout milliseconds 3600000,
gracefulIgnoreSessions boolean false,
gracefulProductionToAdmin boolean false,
retireGracefully boolean true,
retireTimeout seconds -1 (no timeout),
adminMode boolean false,
timeout milliseconds 0 (no timeout)
RuntimeException
- if the operation cannot be started
All other errors are reported via the returned
DeploymentProgressObjectMBean.String[] getModules()
The list of modules for the application. These modules can be used in module level targeting.
String getState(String target)
The state of the application for a target.
Notifications will be generated for this attribute on state changes.
Valid states are those supported by the
AppRuntimeStateRuntimeMBean
The notification types are
appdeployment.created, appdeployment.deleted, appdeployment.state.new,
appdeployment.state.prepared, appdeployment.state.admin,
appdeployment.state.active, appdeployment.state.retired,
appdeployment.state.failed, appdeployment.state.update.pending, and
appdeployment.state.unknown. The userdata is a Map where the
keys are target names and the values are the application state for
that target.
target
- the target for the application state
DeploymentProgressObjectMBean update(String[] targets, String plan, Properties deploymentOptions) throws RuntimeException
A configuration update is equivalent to replacing the application's deployment plan. The deployment plan is redeployed in-place. A new version of the application is not started, even if the new deployment plan has a different version.
The update succeeds only if changes to the deployment plan do not
require the application to be restarted. Configuration changes in
the new deployment plan must be limited to
tuning the application. Changes to resource bindings causes
the update to fail. Use AppDeploymentRuntimeMBean.redeploy()
to apply resource binding changes to a production application.
This method targets only root modules. Module level targeting is not supported.
targets
- represent the targets on which to update the
application.plan
- The deployment plan containing the new deployment
configuration information.deploymentOptions
- Allows for overriding the deployment options. May
be null.
RuntimeException.
- All other errors are reported via the returned DeploymentProgressObject.
RuntimeException
AppDeploymentRuntimeMBean.redeploy()
|
Copyright 1996, 2014, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.3) Part Number E41849-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |