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

Part Number E27170-02

weblogic.management.configuration
Interface SingletonServiceBaseMBean

All Superinterfaces:
ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean
All Known Subinterfaces:
JTAMigratableTargetMBean, MigratableTargetMBean, SingletonServiceAppScopedMBean, SingletonServiceMBean

public interface SingletonServiceBaseMBean
extends ConfigurationMBean

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:
TargetMBean, SingletonServiceMBean, SingletonServiceAppScopedMBean

Field Summary
 
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY
 
Method Summary
 int getAdditionalMigrationAttempts()
          A migratable service could fail to come up on every possible configured server.
 ServerMBean getHostingServer()
          Returns the name of the server that currently hosts the singleton service.
 int getMillisToSleepBetweenAttempts()
          Controls how long of a pause there should be between the migration attempts described in getAdditionalMigrationAttempts().
 ServerMBean getUserPreferredServer()
          Returns the server that the user prefers the singleton service to be active on.
 void setAdditionalMigrationAttempts(int attempts)
           
 void setMillisToSleepBetweenAttempts(int millis)
           
 void setUserPreferredServer(ServerMBean t)
           
 
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

getHostingServer

ServerMBean getHostingServer()

Returns the name of the server that currently hosts the singleton service.

Returns:
The hostingServer value

getUserPreferredServer

ServerMBean getUserPreferredServer()

Returns the server that the user prefers the singleton service to be active on.

Returns:
The UserPreferredServer value

setUserPreferredServer

void setUserPreferredServer(ServerMBean t)
Parameters:
t - The new UserPreferredServer value

getAdditionalMigrationAttempts

int getAdditionalMigrationAttempts()
A migratable service could fail to come up on every possible configured server. This attribute controls how many further attempts, after the service has failed on every server at least once, should be tried. Note that each attempt specified here indicates another full circuit of migrations amongst all the configured servers. So for a 3-server cluster, and a value of 2, a total of 4 additional migrations will be attempted. (the original server is never a valid destination)

Default Value:
2

setAdditionalMigrationAttempts

void setAdditionalMigrationAttempts(int attempts)
Parameters:
attempts - number of additional attempts
See Also:
SingletonServiceBaseMBean.getAdditionalMigrationAttempts()

getMillisToSleepBetweenAttempts

int getMillisToSleepBetweenAttempts()
Controls how long of a pause there should be between the migration attempts described in getAdditionalMigrationAttempts(). Note that this delay only happens when the service has failed to come up on every server. It does not cause any sort of delay between attempts to migrate otherwise.

Default Value:
300000

setMillisToSleepBetweenAttempts

void setMillisToSleepBetweenAttempts(int millis)
Parameters:
millis - how long to pause, in millis
See Also:
SingletonServiceBaseMBean.getMillisToSleepBetweenAttempts()

Copyright 1996, 2013, 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.2)

Part Number E27170-02