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.
| Since | 9.0.2.0 |
| Fully Qualified Interface Name | If 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 |
This section describes attributes that provide access to other MBeans.
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.
| Privileges | Read/Write |
| Type | ServerMBean[] |
| Relationship type: | Reference. |
Returns the cluster this singleton service is associated with.
| Privileges | Read/Write |
| Type | ClusterMBean |
| Relationship type: | Reference. |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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.
| Privileges | Read/Write |
| Type | ServerMBean[] |
| Relationship type: | Reference. |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Returns the name of the server that currently hosts the singleton service.
| Privileges | Read only |
| Type | ServerMBean |
| Relationship type: | Reference. |
Returns the server that the user prefers the singleton service to be active on.
| Privileges | Read/Write |
| Type | ServerMBean |
| Relationship type: | Reference. |
This section describes the following attributes:
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)
| Privileges | Read/Write |
| Type | int |
| Default Value | 2 |
Private property that disables caching in proxies.
| Privileges | Read only |
| Type | boolean |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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 |
| Type | java.lang.String |
Return whether the MBean was created dynamically or is persisted to config.xml
| Privileges | Read only |
| Type | boolean |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Return the unique id of this MBean instance
| Privileges | Read only |
| Type | long |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Returns the MBean info for this MBean.
Deprecated.
| Privileges | Read only |
| Type | javax.management.MBeanInfo |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
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 |
| Type | int |
| Default Value | 300000 |
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 |
| Type | java.lang.String |
Optional information that you can include to describe this configuration.
WebLogic Server saves this note in the domain's configuration
file (config.xml) as XML PCDATA. All left angle
brackets (<) are converted to the XML entity
<. 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 |
| Security roles | Write access is granted only to the following roles:
|
| Type | java.lang.String |
Returns the ObjectName under which this MBean is registered in the MBean server.
Deprecated.
| Privileges | Read only |
| Type | weblogic.management.WebLogicObjectName |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Return the immediate parent for this MBean
| Privileges | Read/Write |
| Type |
Returns false if the MBean represented by this object has been unregistered.
Deprecated.
| Privileges | Read only |
| Type | boolean |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
Return all tags on this Configuration MBean
| Available Since | Release 12.2.1.0.0 |
| Privileges | Read/Write |
| Type | class java.lang.String[] |
Returns the type of the MBean.
| Privileges | Read only |
| Type | java.lang.String |
| Redeploy or Restart required | Changes take effect after you redeploy the module or restart the server. |
This section describes the following operations:
| Operation Name | "addConstrainedCandidateServer" |
| Parameters | Object [] { constrainedCandidateServer }
where:
|
| Signature | String [] {
"weblogic.management.configuration.ServerMBean" } |
| Returns |
boolean
|
| Exceptions |
|
Add a tag to this Configuration MBean. Adds a tag to the current set of tags on the Configuration MBean. Tags may contain white spaces.
| Operation Name | "addTag" |
| Parameters | Object [] { tag }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
boolean
|
| Exceptions |
|
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.
| Operation Name | "freezeCurrentValue" |
| Parameters | Object [] { attributeName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Return all properties' names whose value is inherited from template mbean. this is a convenient method to get inheritance info on multiple properties in one jmx call.
| Operation Name | "getInheritedProperties" |
| Parameters | Object [] { propertyNames }
where:
|
| Signature | String [] {
"[Ljava.lang.String;" } |
| Returns |
class |
Check if the value of a property is inherited from template mbean or not.
| Operation Name | "isInherited" |
| Parameters | Object [] { propertyName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
boolean
|
Returns true if the specified attribute has been set explicitly in this MBean instance.
| Operation Name | "isSet" |
| Parameters | Object [] { propertyName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
boolean
|
| Operation Name | "removeConstrainedCandidateServer" |
| Parameters | Object [] { constrainedCandidateServer }
where:
|
| Signature | String [] {
"weblogic.management.configuration.ServerMBean" } |
| Returns |
boolean
|
| Exceptions |
|
Remove a tag from this Configuration MBean
| Operation Name | "removeTag" |
| Parameters | Object [] { tag }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
boolean
|
| Exceptions |
|
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.
| Operation Name | "restoreDefaultValue" |
| Parameters | Object [] { attributeName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|
| Exceptions |
|
Restore the given property to its default value.
| Operation Name | "unSet" |
| Parameters | Object [] { propertyName }
where:
|
| Signature | String [] {
"java.lang.String" } |
| Returns |
void
|