Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02

weblogic.management.configuration
Interface DeploymentMBean

All Superinterfaces:
ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean
All Known Subinterfaces:
CacheMBean, CapacityMBean, ClassDeploymentMBean, ComponentMBean, ConnectorComponentMBean, ContextCaseMBean, ContextRequestClassMBean, DataSourceMBean, EJBComponentMBean, FairShareRequestClassMBean, FileStoreMBean, ForeignJMSServerMBean, ForeignJNDIProviderMBean, HTTPProxyMBean, JDBCConnectionPoolMBean, JDBCDataSourceMBean, JDBCMultiPoolMBean, JDBCStoreMBean, JDBCTxDataSourceMBean, JMSConnectionFactoryMBean, JMSDistributedDestinationMBean, JMSDistributedQueueMBean, JMSDistributedTopicMBean, JMSServerMBean, JMSVirtualDestinationMBean, JoltConnectionPoolMBean, MailSessionMBean, MaxThreadsConstraintMBean, MessagingBridgeMBean, MinThreadsConstraintMBean, NetworkChannelMBean, OsgiFrameworkMBean, PathServiceMBean, PersistentStoreMBean, ReplicatedStoreMBean, ResponseTimeRequestClassMBean, RMCFactoryMBean, SAFAgentMBean, ShutdownClassMBean, SNMPAgentDeploymentMBean, StartupClassMBean, TransactionLogJDBCStoreMBean, TransactionLogStoreMBean, VirtualDestinationMBean, VirtualHostMBean, WebAppComponentMBean, WebDeploymentMBean, WebServerMBean, WebServiceComponentMBean, WLECConnectionPoolMBean, WorkManagerMBean, WTCServerMBean

public interface DeploymentMBean
extends ConfigurationMBean

A Deployment is any MBean that may be deployed on one or more targets, such as a Component, a Web Server personality, a JMS Front-end or back-end or a JDBC connection pool. A deployment has targets, which specify which servers the deployment should be deployed on. Assigning the targets on a deployment will cause the deployment to get deployed on those targets. If the targets overlap, the deployment will only be deployed once. For example, if a deployment is deployed both on a cluster C and on a server S that is a member of that cluster, the deployment will be deployed on S only once. Simply adding or removing a target will not affect the deployment state for this deployment. The user must explicitly activate or deactivate the deployment. Certain types of deployments, ComponentMBeans, behave slightly differently. Please refer to their documentation for more information.


Field Summary
static int DEFAULT_ORDER
          The default deployment order.
static int MAX_ORDER
          The maximum value for a deployment order.
static int MIN_ORDER
          The minimum value for a deployment order.
 
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY
 
Method Summary
 boolean addTarget(TargetMBean target)
          You can add a target to specify additional servers on which the deployment can be deployed.
 int getDeploymentOrder()
          A priority that the server uses to determine when it deploys an item.
 TargetMBean[] getTargets()
          You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed.
 boolean removeTarget(TargetMBean target)
          Removes the value of the addTarget attribute.
 void setDeploymentOrder(int order)
          Sets the value of the DeploymentOrder attribute.
 void setTargets(TargetMBean[] Targets)
          Sets the value of the getTargets attribute.
 
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet
 
Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, 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
 
Methods inherited from interface weblogic.descriptor.DescriptorBean
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener
 

Field Detail

DEFAULT_ORDER

static final int DEFAULT_ORDER
The default deployment order. This is a midrange value.

See Also:
Constant Field Values

MIN_ORDER

static final int MIN_ORDER
The minimum value for a deployment order. This represents the highest priority in terms of deployment.

See Also:
Constant Field Values

MAX_ORDER

static final int MAX_ORDER
The maximum value for a deployment order. This represents the lowest priority in terms of deployment.

See Also:
Constant Field Values
Method Detail

getTargets

TargetMBean[] getTargets()

You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.

Returns:
The targets value

setTargets

void setTargets(TargetMBean[] Targets)
                throws InvalidAttributeValueException,
                       DistributedManagementException

Sets the value of the getTargets attribute.

Parameters:
Targets - The new targets value
Throws:
InvalidAttributeValueException
DistributedManagementException
See Also:
DeploymentMBean.getTargets()

addTarget

boolean addTarget(TargetMBean target)
                  throws InvalidAttributeValueException,
                         DistributedManagementException

You can add a target to specify additional servers on which the deployment can be deployed. The targets must be either clusters or servers.

Parameters:
target - The feature to be added to the Target attribute
Returns:
returns true if successful
Throws:
InvalidAttributeValueException
DistributedManagementException

removeTarget

boolean removeTarget(TargetMBean target)
                     throws InvalidAttributeValueException,
                            DistributedManagementException

Removes the value of the addTarget attribute.

Parameters:
target -
Returns:
returns true if successful
Throws:
InvalidAttributeValueException
DistributedManagementException
See Also:
DeploymentMBean.addTarget(weblogic.management.configuration.TargetMBean)

getDeploymentOrder

int getDeploymentOrder()

A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.

For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

Returns:
The deploymentOrder value
Default Value:
DeploymentMBean.DEFAULT_ORDER
Maximum Value:
DeploymentMBean.MAX_ORDER
Minimum Value:
DeploymentMBean.MIN_ORDER

setDeploymentOrder

void setDeploymentOrder(int order)

Sets the value of the DeploymentOrder attribute.

Parameters:
order - The new deploymentOrder value
See Also:
DeploymentMBean.getDeploymentOrder()

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