Type-Safe Access to BEA WebLogic Server 9.2 MBeans (Deprecated)

(Methods marked with @since 9.0.0.0 are not available through the deprecated MBeanHome interface.)

weblogic.management.configuration
Interface MigratableTargetMBean

All Superinterfaces:

ConfigurationMBean, weblogic.descriptor.DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, weblogic.descriptor.SettableBean, weblogic.management.configuration.SingletonServiceBaseMBean, TargetMBean, weblogic.management.WebLogicMBean

All Known Subinterfaces:

JTAMigratableTargetMBean

public interface MigratableTargetMBean

extends weblogic.management.configuration.SingletonServiceBaseMBean, TargetMBean

A target that is suitable for services that shall be active on at most one server of a cluster at a time.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/documentation/index.html.

Since:

7.0.0.0

See Also:

TargetMBean, SingletonServiceBaseMBean

Field Summary

static String

DEFAULT_MIGRATABLETARGET_SUFFIX

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean

DEFAULT_EMPTY_BYTE_ARRAY

Method Summary

boolean	addConstrainedCandidateServer(ServerMBean constrainedCandidateServer)
ServerMBean[]	getAllCandidateServers() Return a list of servers that are candiates to host the services deployed to this migratable target.
ClusterMBean	getCluster() Returns the cluster this singleton service is associated with.
ServerMBean[]	getConstrainedCandidateServers() Returns the (user restricted) list of servers that may host the Singleton.
ServerMBean	getDestinationServer()
boolean	isCurrentServerRunning()
boolean	isDestinationServerRunning()
boolean	removeConstrainedCandidateServer(ServerMBean constrainedCandidateServer)
void	setAllCandidateServers(ServerMBean[] servers) // NOTE reto@bea.com 2001-Jul-30 -- NOT TO BE USED FROM THE OUTSIDE.
void	setCluster(ClusterMBean cluster) Set the cluster this singleton service is associated with.
void	setConstrainedCandidateServers(ServerMBean[] constrainedCandidateServers) All constrained candiate servers must belong to the same cluster.
void	setCurrentServerRunning(boolean up)
void	setDestinationServer(ServerMBean t)
void	setDestinationServerRunning(boolean up)
void	setPreScript(String filePath)
void	setUserPreferredServer(ServerMBean t)

Methods inherited from interface weblogic.management.configuration.SingletonServiceBaseMBean

getAdditionalMigrationAttempts, getHostingServer, getMillisToSleepBetweenAttempts, getUserPreferredServer, setAdditionalMigrationAttempts, setHostingServer, setMillisToSleepBetweenAttempts

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean

freezeCurrentValue, getName, getNotes, 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

addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener

Field Detail

DEFAULT_MIGRATABLETARGET_SUFFIX

public static final String DEFAULT_MIGRATABLETARGET_SUFFIX

See Also:

Constant Field Values

Method Detail

addConstrainedCandidateServer

public boolean addConstrainedCandidateServer(ServerMBean constrainedCandidateServer)
                                      throws InvalidAttributeValueException

Parameters:

constrainedCandidateServer - The feature to be added to the ConstrainedCandidateServer attribute

Returns:

Throws:

InvalidAttributeValueException

getAllCandidateServers

public ServerMBean[] getAllCandidateServers()

Return a list of servers that are candiates to host the services deployed to this migratable target. If the ConstrainedCandidateServer list is empty, all servers in the cluster are returned. If the ConstrainedCandidateServer is not empty those servers only will be returned. The user preferred server will be the first element in the list returned.

Returns:

The allCandidateServers value

getCluster

public ClusterMBean getCluster()

Returns the cluster this singleton service is associated with.

Returns:

The cluster value

getConstrainedCandidateServers

public ServerMBean[] getConstrainedCandidateServers()

Returns the (user restricted) list of servers that may host the Singleton. The Singleton will not be allowed to migrate to a server that is not in the returned list of servers. This feature may be used to configure the two server that have acceess to a dual ported disk, for example. All servers in this list must be part of the cluster that is associated with the Singleton.

Returns:

The constrainedCandidateServers value

getDestinationServer

public ServerMBean getDestinationServer()

Returns:

The destinationServer value

isCurrentServerRunning

public boolean isCurrentServerRunning()

Returns:

The currentServerRunning value

isDestinationServerRunning

public boolean isDestinationServerRunning()

Returns:

The destinationServerRunning value

removeConstrainedCandidateServer

public boolean removeConstrainedCandidateServer(ServerMBean constrainedCandidateServer)
                                         throws InvalidAttributeValueException

Parameters:

constrainedCandidateServer -

Returns:

Throws:

InvalidAttributeValueException

setAllCandidateServers

public void setAllCandidateServers(ServerMBean[] servers)

// NOTE reto@bea.com 2001-Jul-30 -- NOT TO BE USED FROM THE OUTSIDE. MUST BE HERE ONLY TO SATISFY THE MBEAN SERVER. AllCandiateServers IS A DERIVED ATTRIBUTE AND THUS MUST NOT BE SET.

Parameters:

servers - The new allCandidateServers value

setCluster

public void setCluster(ClusterMBean cluster)

Set the cluster this singleton service is associated with.

Parameters:

cluster - The new cluster value

setConstrainedCandidateServers

public void setConstrainedCandidateServers(ServerMBean[] constrainedCandidateServers)
                                    throws InvalidAttributeValueException

All constrained candiate servers must belong to the same cluster.

Parameters:

constrainedCandidateServers - The new constrainedCandidateServers value

Throws:

InvalidAttributeValueException

setCurrentServerRunning

public void setCurrentServerRunning(boolean up)

Parameters:

up - The new currentServerRunning value

setDestinationServer

public void setDestinationServer(ServerMBean t)

Parameters:

t - The new destinationServer value

setDestinationServerRunning

public void setDestinationServerRunning(boolean up)

Parameters:

up - The new destinationServerRunning value

setPreScript

public void setPreScript(String filePath)

Parameters:

filePath - file name and relative path for pre script * @exclude

See Also:

getPreScript()

setUserPreferredServer

public void setUserPreferredServer(ServerMBean t)

Specified by:

setUserPreferredServer in interface weblogic.management.configuration.SingletonServiceBaseMBean

Parameters:

t - The new userPreferredServer value