SingletonServiceMBean


Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

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.

       
Since9.0.2.0
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.configuration.SingletonServiceMBean

For more information, see:

Factory Methods


Related MBeans

This section describes attributes that provide access to other MBeans.


AllCandidateServers

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.

       
Privileges Read/Write
TypeServerMBean[]
Relationship type: Reference.

Cluster

Returns the cluster this singleton service is associated with.

       
Privileges Read/Write
TypeClusterMBean
Relationship type: Reference.
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

ConstrainedCandidateServers

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 acceess to a dual ported disk. All servers in this list must be part of the cluster that is associated with the migratable target.

       
Privileges Read/Write
TypeServerMBean[]
Relationship type: Reference.
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

HostingServer

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

       
Privileges Read only
TypeServerMBean
Relationship type: Reference.

UserPreferredServer

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

       
Privileges Read/Write
TypeServerMBean
Relationship type: Reference.


Attributes

This section describes the following attributes:


AdditionalMigrationAttempts

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 circut 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)

       
Privileges Read/Write
Typeint
Default Value2

CachingDisabled

Private property that disables caching in proxies.

       
Privileges Read only
Typeboolean
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

ClassName

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

       
Privileges Read/Write
Typejava.lang.String

MBeanInfo

Returns the MBean info for this MBean.

Deprecated.

       
Privileges Read only
Typejavax.management.MBeanInfo
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

MillisToSleepBetweenAttempts

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.

       
Privileges Read/Write
Typeint
Default Value300000

Name

The user-specified name of this MBean instance.

This name is included as one of the key properties in the MBean's javax.management.ObjectName:
Name=user-specified-name

       
Privileges Read/Write
Typejava.lang.String

Notes

Optional information that you can include to describe this configuration.

WebLogic Sever saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. Carriage returns/line feeds are preserved.

Note:

If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

       
Privileges Read/Write
Typejava.lang.String

ObjectName

Returns the ObjectName under which this MBean is registered in the MBean server.

Deprecated.

       
Privileges Read only
Typeweblogic.management.WebLogicObjectName
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

Parent

Return the immediate parent for this MBean

       
Privileges Read/Write
Type

Registered

Returns false if the the MBean represented by this object has been unregistered.

Deprecated.

       
Privileges Read only
Typeboolean
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

Type

Returns the type of the MBean.

       
Privileges Read only
Typejava.lang.String
Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.


Operations

This section describes the following operations:


addConstrainedCandidateServer

   
Operation Name"addConstrainedCandidateServer"
ParametersObject [] {  constrainedCandidateServer }

where:

  • constrainedCandidateServer is an object of type weblogic.management.configuration.ServerMBean that specifies:

    The server to be added as a constrained candidate

SignatureString [] { "weblogic.management.configuration.ServerMBean" }
Returns boolean
Exceptions
  • javax.management.InvalidAttributeValueException

freezeCurrentValue

If the specified attribute has not been set explicitly, and if the attribute has a default value, this operation forces the MBean to persist the default value.

Unless you use this operation, the default value is not saved and is subject to change if you update to a newer release of WebLogic Server. Invoking this operation isolates this MBean from the effects of such changes.

Note:

To insure that you are freezing the default value, invoke the restoreDefaultValue operation before you invoke this.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute for which some other value has been set.

Deprecated. 9.0.0.0

   
Operation Name"freezeCurrentValue"
ParametersObject [] {  attributeName }

where:

  • attributeName is an object of type java.lang.String that specifies:

    attributeName

SignatureString [] { "java.lang.String" }
Returns void
Exceptions
  • javax.management.AttributeNotFoundException
  • javax.management.MBeanException

isSet

Returns true if the specified attribute has been set explicitly in this MBean instance.

   
Operation Name"isSet"
ParametersObject [] {  propertyName }

where:

  • propertyName is an object of type java.lang.String that specifies:

    property to check

SignatureString [] { "java.lang.String" }
Returns boolean

removeConstrainedCandidateServer

   
Operation Name"removeConstrainedCandidateServer"
ParametersObject [] {  constrainedCandidateServer }

where:

  • constrainedCandidateServer is an object of type weblogic.management.configuration.ServerMBean that specifies:

    constrainedCandidateServer

SignatureString [] { "weblogic.management.configuration.ServerMBean" }
Returns boolean
Exceptions
  • javax.management.InvalidAttributeValueException

restoreDefaultValue

If the specified attribute has a default value, this operation removes any value that has been set explicitly and causes the attribute to use the default value.

Default values are subject to change if you update to a newer release of WebLogic Server. To prevent the value from changing if you update to a newer release, invoke the freezeCurrentValue operation.

This operation has no effect if you invoke it on an attribute that does not provide a default value or on an attribute that is already using the default.

Deprecated. 9.0.0.0

   
Operation Name"restoreDefaultValue"
ParametersObject [] {  attributeName }

where:

  • attributeName is an object of type java.lang.String that specifies:

    attributeName

SignatureString [] { "java.lang.String" }
Returns void
Exceptions
  • javax.management.AttributeNotFoundException

unSet

Restore the given property to its default value.

   
Operation Name"unSet"
ParametersObject [] {  propertyName }

where:

  • propertyName is an object of type java.lang.String that specifies:

    property to restore

SignatureString [] { "java.lang.String" }
Returns void