SingletonServiceAppScopedMBean


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.2.0.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.SingletonServiceAppScopedMBean

For more information, see:

Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points Inherited from SubDeploymentMBean Because this MBean extends or implements SubDeploymentMBean, you can also access this MBean by retrieving SubDeploymentMBeans. The following attributes contain SubDeploymentMBeans and its subtypes:


Related MBeans

This section describes attributes that provide access to other MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.


HostingServer

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

       
Privileges Read only
TypeServerMBean
Relationship type: Reference.

SubDeployments

The subdeployment groups within this JMS module. Subdeployments enable you to deploy some resources in a JMS module to a JMS server and other JMS resources to a server instance or cluster.

Standalone queues or topics can only be targeted to a single JMS server. Whereas, connection factories, uniform distributed destinations (UDDs), and foreign servers can be targeted to one or more JMS servers, one or more server instances, or to a cluster. Therefore, standalone queues or topics cannot be associated with a subdeployment if other members of the subdeployment are targeted to multiple JMS servers. However, UDDs can be associated with such subdeployments since the purpose of UDDs is to distribute its members to multiple JMS servers in a domain.

           
Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
Lookup OperationlookupSubDeployment(String name)

Returns a javax.management.ObjectName for the instance of SubDeploymentMBean named name.

Privileges Read only
TypeSubDeploymentMBean[]
Relationship type: Containment.

Targets

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.

       
Privileges Read/Write
TypeTargetMBean[]
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

CompatibilityName

This is only set for beans created as a result of conversion from an 8.1 application configured using ApplicationMBean and ComponentMBean.

Standalone modules in 8.1 have both an ApplicationMBean name and ComponentMBean name. This attribute stores the name of the latter, to be used when the server creates the transient ComponentMBean for backward compatibility.

       
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

ModuleType

The values match those defined by jsr88. This attribute may move to another MBean.

       
Privileges Read/Write
Typejava.lang.String

Name

Unique identifier for this bean instance. It is used by the application container to match the module in the application package to the targeting information in the configuration.

For modules within an EAR, the name should be the URI of the module as defined in the META-INF/application.xml deployment descriptor. There is an exception to this for web applications. See below.

For web modules in an EAR, the name should always equal the context root of that webapp, because the URI is not always unique

       
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:


addTarget

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

   
Operation Name"addTarget"
ParametersObject [] {  target }

where:

  • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

    The feature to be added to the Target attribute

SignatureString [] { "weblogic.management.configuration.TargetMBean" }
Returns void
Exceptions
  • javax.management.InvalidAttributeValueException
  • weblogic.management.DistributedManagementException

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

removeTarget

Removes the value of the Target attribute.

For more information, see:

   
Operation Name"removeTarget"
ParametersObject [] {  target }

where:

  • target is an object of type weblogic.management.configuration.TargetMBean that specifies:

    The target to remove

SignatureString [] { "weblogic.management.configuration.TargetMBean" }
Returns void
Exceptions
  • javax.management.InvalidAttributeValueException
  • weblogic.management.DistributedManagementException

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