ResourceGroupTemplateMBean

Overview | Related MBeans | Attributes | Operations

Overview

A resource group template is a named, domain-level collection of deployable resources intended to be used as a pattern by (usually) multiple resource groups. Each resource group that refers to a given template will have its own runtime copies of the resources defined in the template.

Since 12.2.1.0.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.ResourceGroupTemplateMBean

Factory Methods

Factory methods in DomainMBean

Additional Access Points

In addition to accessing this MBean by invoking a factory method, you can also access this MBean from the following MBean attributes:

ResourceGroupMBean.ResourceGroupTemplate

Subtypes

The following MBeans extend or implement this MBean type:

ResourceGroupMBean

Related MBeans

This section describes attributes that provide access to other MBeans.

AppDeployments
CoherenceClusterSystemResources
FileStores
ForeignJNDIProviders
JDBCStores
JDBCSystemResources
JMSBridgeDestinations
JMSServers
JMSSystemResources
Libraries

MailSessions
ManagedExecutorServices
ManagedScheduledExecutorServices
ManagedThreadFactories
MessagingBridges
OsgiFrameworks
PathServices
SAFAgents
WLDFSystemResources

AppDeployments

The collection of deployable entities in this resource group template.

Factory Methods	No explicit creator method. The child shares the lifecycle of its parent.
Lookup Operation	`lookupAppDeployment(String name)` Returns a `javax.management.ObjectName` for the instance of `AppDeploymentMBean` named `name`.
Privileges	Read only
Type	AppDeploymentMBean[]
Relationship type:	Containment.

CoherenceClusterSystemResources

The CoherenceClusterSystemResourceMBeans that have been defined for this resource group template.

Deprecated. 12.2.1.1.0 Coherence Clusters cannot be targeted to ResourceGroupTemplates

Factory Methods	`createCoherenceClusterSystemResource (java.lang.String name)` `destroyCoherenceClusterSystemResource (CoherenceClusterSystemResourceMBean bean)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupCoherenceClusterSystemResource(String name)` Returns a `javax.management.ObjectName` for the instance of `CoherenceClusterSystemResourceMBean` named `name`.
Privileges	Read only
Type	CoherenceClusterSystemResourceMBean[]
Relationship type:	Containment.

FileStores

The file stores defined in this resource group template.

Factory Methods	`createFileStore (java.lang.String name)` `destroyFileStore (FileStoreMBean store)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupFileStore(String name)` Returns a `javax.management.ObjectName` for the instance of `FileStoreMBean` named `name`.
Privileges	Read only
Type	FileStoreMBean[]
Relationship type:	Containment.

ForeignJNDIProviders

The Foreign JNDI Providers defined for this resource group template.

Factory Methods	`createForeignJNDIProvider (java.lang.String name)` `destroyForeignJNDIProvider (ForeignJNDIProviderMBean provider)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupForeignJNDIProvider(String name)` Returns a `javax.management.ObjectName` for the instance of `ForeignJNDIProviderMBean` named `name`.
Privileges	Read only
Type	ForeignJNDIProviderMBean[]
Relationship type:	Containment.

JDBCStores

The JDBCStores defined in this resource group template.

Factory Methods	`createJDBCStore (java.lang.String name)` `destroyJDBCStore (JDBCStoreMBean store)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupJDBCStore(String name)` Returns a `javax.management.ObjectName` for the instance of `JDBCStoreMBean` named `name`.
Privileges	Read only
Type	JDBCStoreMBean[]
Relationship type:	Containment.

JDBCSystemResources

The JDBCSystemResourceMBeans that have been defined for this resource group template.

Factory Methods	`createJDBCSystemResource (java.lang.String name)` `destroyJDBCSystemResource (JDBCSystemResourceMBean bean)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupJDBCSystemResource(String name)` Returns a `javax.management.ObjectName` for the instance of `JDBCSystemResourceMBean` named `name`.
Privileges	Read only
Type	JDBCSystemResourceMBean[]
Relationship type:	Containment.

JMSBridgeDestinations

The JMSBridgeDestinations for this resource group template.

Factory Methods	`createJMSBridgeDestination (java.lang.String name)` `destroyJMSBridgeDestination (JMSBridgeDestinationMBean jmsBridgeDestination)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupJMSBridgeDestination(String name)` Returns a `javax.management.ObjectName` for the instance of `JMSBridgeDestinationMBean` named `name`.
Privileges	Read only
Type	JMSBridgeDestinationMBean[]
Relationship type:	Containment.

JMSServers

Define JMSServers for this resource group template.

Factory Methods	`createJMSServer (java.lang.String name)` `destroyJMSServer (JMSServerMBean jmsServer)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupJMSServer(String name)` Returns a `javax.management.ObjectName` for the instance of `JMSServerMBean` named `name`.
Privileges	Read only
Type	JMSServerMBean[]
Relationship type:	Containment.

JMSSystemResources

The JMSSystemResourceMBeans that have been defined for this resource group template.

Factory Methods	`createJMSSystemResource (java.lang.String name)` `destroyJMSSystemResource (JMSSystemResourceMBean bean)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupJMSSystemResource(String name)` Returns a `javax.management.ObjectName` for the instance of `JMSSystemResourceMBean` named `name`.
Privileges	Read only
Type	JMSSystemResourceMBean[]
Relationship type:	Containment.

Libraries

Define libraries for this resource group template.

Factory Methods	No explicit creator method. The child shares the lifecycle of its parent.
Lookup Operation	`lookupLibrary(String name)` Returns a `javax.management.ObjectName` for the instance of `LibraryMBean` named `name`.
Privileges	Read only
Type	LibraryMBean[]
Relationship type:	Containment.

MailSessions

The MailSessions for this resource group template.

Factory Methods	`createMailSession (java.lang.String name)` `destroyMailSession (MailSessionMBean ms)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupMailSession(String name)` Returns a `javax.management.ObjectName` for the instance of `MailSessionMBean` named `name`.
Privileges	Read only
Type	MailSessionMBean[]
Relationship type:	Containment.

ManagedExecutorServices

All the ManagedExecutorServices.

Factory Methods	`createManagedExecutorService (java.lang.String name)` `destroyManagedExecutorService (ManagedExecutorServiceMBean bean)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupManagedExecutorService(String name)` Returns a `javax.management.ObjectName` for the instance of `ManagedExecutorServiceMBean` named `name`.
Privileges	Read only
Type	ManagedExecutorServiceMBean[]
Relationship type:	Containment.

ManagedScheduledExecutorServices

All the ManagedScheduledExecutorService.

Factory Methods	`createManagedScheduledExecutorService (java.lang.String name)` `destroyManagedScheduledExecutorService (ManagedScheduledExecutorServiceMBean bean)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupManagedScheduledExecutorService(String name)` Returns a `javax.management.ObjectName` for the instance of `ManagedScheduledExecutorServiceMBean` named `name`.
Privileges	Read only
Type	ManagedScheduledExecutorServiceMBean[]
Relationship type:	Containment.

ManagedThreadFactories

All the ManagedThreadFactories.

Factory Methods	`createManagedThreadFactory (java.lang.String name)` `destroyManagedThreadFactory (ManagedThreadFactoryMBean bean)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupManagedThreadFactory(String name)` Returns a `javax.management.ObjectName` for the instance of `ManagedThreadFactoryMBean` named `name`.
Privileges	Read only
Type	ManagedThreadFactoryMBean[]
Relationship type:	Containment.

MessagingBridges

The MessagingBridgeMBean representing the messaging bridges that have been configured to be part of this resource group template.

Factory Methods	`createMessagingBridge (java.lang.String name)` `destroyMessagingBridge (MessagingBridgeMBean bridge)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupMessagingBridge(String name)` Returns a `javax.management.ObjectName` for the instance of `MessagingBridgeMBean` named `name`.
Privileges	Read only
Type	MessagingBridgeMBean[]
Relationship type:	Containment.

OsgiFrameworks

OSGi framework definition for use by applications wishing to share services and code

Factory Methods	`createOsgiFramework (java.lang.String name)` `destroyOsgiFramework (OsgiFrameworkMBean osgiFramework)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupOsgiFramework(String name)` Returns a `javax.management.ObjectName` for the instance of `OsgiFrameworkMBean` named `name`.
Privileges	Read only
Type	OsgiFrameworkMBean[]
Relationship type:	Containment.

PathServices

The PathServices for this resource group template.

Factory Methods	`createPathService (java.lang.String name)` `destroyPathService (PathServiceMBean pathService)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupPathService(String name)` Returns a `javax.management.ObjectName` for the instance of `PathServiceMBean` named `name`.
Privileges	Read only
Type	PathServiceMBean[]
Relationship type:	Containment.

SAFAgents

The SAFAgentMBeans for this resource group template

Factory Methods	`createSAFAgent (java.lang.String name)` `destroySAFAgent (SAFAgentMBean sAFAgent)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupSAFAgent(String name)` Returns a `javax.management.ObjectName` for the instance of `SAFAgentMBean` named `name`.
Privileges	Read only
Type	SAFAgentMBean[]
Relationship type:	Containment.

WLDFSystemResources

The WLDFSystemResourceMBeans that have been defined for this resource group template

Factory Methods	`createWLDFSystemResource (java.lang.String name)` `destroyWLDFSystemResource (WLDFSystemResourceMBean bean)` Factory methods do not return objects. See Using factory methods.
Lookup Operation	`lookupWLDFSystemResource(String name)` Returns a `javax.management.ObjectName` for the instance of `WLDFSystemResourceMBean` named `name`.
Privileges	Read only
Type	WLDFSystemResourceMBean[]
Relationship type:	Containment.

Attributes

This section describes the following attributes:

CachingDisabled
DynamicallyCreated
Id
MBeanInfo
Name
Notes
ObjectName

Parent
Registered
Tags
Type
UploadDirectoryName

CachingDisabled

Private property that disables caching in proxies.

This attribute is not dynamic and requires a server restart to take effect.

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

DynamicallyCreated

Return whether the MBean was created dynamically or is persisted to config.xml

This attribute is not dynamic and requires a server restart to take effect.

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

Id

Return the unique id of this MBean instance

This attribute is not dynamic and requires a server restart to take effect.

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

MBeanInfo

Returns the MBean info for this MBean.

This attribute is not dynamic and requires a server restart to take effect.

Deprecated.

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

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
Type	java.lang.String

Notes

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.

This attribute is not dynamic and requires a server restart to take effect.

Privileges	Read/Write
Security roles	Write access is granted only to the following roles: Deployer Operator
Type	java.lang.String

ObjectName

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

This attribute is not dynamic and requires a server restart to take effect.

Deprecated.

Privileges	Read only
Type	weblogic.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

This attribute is not dynamic and requires a server restart to take effect.

Privileges	Read/Write
Type

Registered

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

This attribute is not dynamic and requires a server restart to take effect.

Deprecated.

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

Type

Returns the type of the MBean.

This attribute is not dynamic and requires a server restart to take effect.

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

UploadDirectoryName

The directory path on the Administration Server where the uploaded applications for this resource group template are placed.

Privileges	Read/Write
Type	java.lang.String

Operations

This section describes the following operations:

addTag
freezeCurrentValue
getInheritedProperties
isInherited
isSet

removeTag
restoreDefaultValue
unSet

addTag

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: `tag` is an object of type `java.lang.String` that specifies: tag to be added to the MBean
Signature	`String [] { "java.lang.String" }`
Returns	`boolean`
Exceptions	`java.lang.IllegalArgumentException` IllegalArgumentException if the tag contains illegal punctuation

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"`
Parameters	`Object [] { attributeName }` where: `attributeName` is an object of type `java.lang.String` that specifies: attributeName
Signature	`String [] { "java.lang.String" }`
Returns	`void`
Exceptions	`javax.management.AttributeNotFoundException` `javax.management.MBeanException`

getInheritedProperties

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: `propertyNames` is an object of type `[Ljava.lang.String;` that specifies: properties to check
Signature	`String [] { "[Ljava.lang.String;" }`
Returns	`class`

isInherited

Check if the value of a property is inherited from template mbean or not.

Operation Name	`"isInherited"`
Parameters	`Object [] { propertyName }` where: `propertyName` is an object of type `java.lang.String` that specifies: the name of the property
Signature	`String [] { "java.lang.String" }`
Returns	`boolean`

isSet

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

Operation Name	`"isSet"`
Parameters	`Object [] { propertyName }` where: `propertyName` is an object of type `java.lang.String` that specifies: property to check
Signature	`String [] { "java.lang.String" }`
Returns	`boolean`

removeTag

Remove a tag from this Configuration MBean

Operation Name	`"removeTag"`
Parameters	`Object [] { tag }` where: `tag` is an object of type `java.lang.String` that specifies: tag to be removed from the MBean
Signature	`String [] { "java.lang.String" }`
Returns	`boolean`
Exceptions	`java.lang.IllegalArgumentException` IllegalArgumentException if the tag contains illegal punctuation

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"`
Parameters	`Object [] { attributeName }` where: `attributeName` is an object of type `java.lang.String` that specifies: attributeName
Signature	`String [] { "java.lang.String" }`
Returns	`void`
Exceptions	`javax.management.AttributeNotFoundException`

unSet

Restore the given property to its default value.

Operation Name	`"unSet"`
Parameters	`Object [] { propertyName }` where: `propertyName` is an object of type `java.lang.String` that specifies: property to restore
Signature	`String [] { "java.lang.String" }`
Returns	`void`

Available Since	Release 12.2.1.0.0
Privileges	Read/Write
Type	class java.lang.String[]