SingletonServiceMBean (Java API Reference for Oracle WebLogic Server)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

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

Part Number E27170-01

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.management.configuration
Interface SingletonServiceMBean

All Superinterfaces:: ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, SingletonServiceBaseMBean, WebLogicMBean

public interface SingletonServiceMBean
extends SingletonServiceBaseMBean
extends SingletonServiceBaseMBean

A service that will be automatically maintained as a Singleton in a cluster. There will always be exactly one instance of it active at any given time.

See Also:: SingletonServiceBaseMBean

Field Summary

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 candidates to host the services deployed to this migratable target.
`String`	`getClassName()` The fully qualified name of a class to load and run.
`ClusterMBean`	`getCluster()` Returns the cluster this singleton service is associated with.
`ServerMBean[]`	`getConstrainedCandidateServers()` Returns the (user restricted) list of servers that may host the migratable target.
`boolean`	`removeConstrainedCandidateServer(ServerMBean constrainedCandidateServer)`
`void`	`setAllCandidateServers(ServerMBean[] servers)` NOT TO BE USED FROM THE OUTSIDE.
`void`	`setClassName(String className)` Sets the value of the className attribute.
`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.

Methods inherited from interface weblogic.management.configuration.SingletonServiceBaseMBean
`getAdditionalMigrationAttempts, getHostingServer, getMillisToSleepBetweenAttempts, getUserPreferredServer, setAdditionalMigrationAttempts, setMillisToSleepBetweenAttempts, setUserPreferredServer`

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`

Method Detail

getClassName

String getClassName()

The fully qualified name of a class to load and run. The class must be on the server's classpath.

For example, mycompany.mypackage.myclass

Returns:: The className value

setClassName

void setClassName(String className)
                  throws InvalidAttributeValueException

Sets the value of the className attribute.

Parameters:

className - The new className value

Throws:

InvalidAttributeValueException

See Also:

SingletonServiceMBean.getClassName()

This method can NOT set a null value.

getConstrainedCandidateServers

ServerMBean[] getConstrainedCandidateServers()

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

Returns:: The constrainedCandidateServers value

setConstrainedCandidateServers

void setConstrainedCandidateServers(ServerMBean[] constrainedCandidateServers)
                                    throws InvalidAttributeValueException

All constrained candiate servers must belong to the same cluster.

Parameters:: constrainedCandidateServers - The new constrainedCandidateServers value
Throws:: InvalidAttributeValueException

addConstrainedCandidateServer

boolean addConstrainedCandidateServer(ServerMBean constrainedCandidateServer)
                                      throws InvalidAttributeValueException

Parameters:: constrainedCandidateServer - The server to be added as a constrained candidate
Throws:: InvalidAttributeValueException

removeConstrainedCandidateServer

boolean removeConstrainedCandidateServer(ServerMBean constrainedCandidateServer)
                                         throws InvalidAttributeValueException

Parameters:: constrainedCandidateServer -
Throws:: InvalidAttributeValueException

getCluster

ClusterMBean getCluster()

Returns the cluster this singleton service is associated with.

Returns:: The cluster value

setCluster

void setCluster(ClusterMBean cluster)

Set the cluster this singleton service is associated with.

Parameters:: cluster - The new cluster value

getAllCandidateServers

ServerMBean[] getAllCandidateServers()

Return a list of servers that are candidates 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

setAllCandidateServers

void setAllCandidateServers(ServerMBean[] servers)

NOT TO BE USED FROM THE OUTSIDE. MUST BE HERE ONLY TO SATISFY THE MBEAN SERVER. AllCandidateServers IS A DERIVED ATTRIBUTE AND THUS MUST NOT BE SET.

Parameters:: servers - The new allCandidateServers value