ForeignServerOverrideMBean

Overview | Related MBeans | Attributes | Operations

Overview

For each configuration entity that supports per-partition-override via a MBean, we have two MBeans, the original configure MBean and the corresponding override MBean, that eventually determine the effective settings of the configured resource. We mark an attribute of an override MBean "dynamic true" even though the original configure MBean masks it "dynamic false". This is to make sure that the overriding settings take effect on partition restart. Otherwise a server restart is required.

Defines partition-specific overrides for the most commonly overridden attributes in a ForeignServer MBean. It overrides some of the settings in a same-named ForeignServer MBean instance in the same multi-tenant scope to which this override MBean belongs.

Since	12.2.1.0.0
Security roles	The following roles have read, write, and invoke permission for all non-encrypted attributes and operations in this MBean: Deployer
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.ForeignServerOverrideMBean`
Factory Methods	Factory methods in JMSSystemResourceOverrideMBean

Related MBeans

This section describes attributes that provide access to other MBeans.

ForeignConnectionFactories
ForeignDestinations

JNDIProperties

ForeignConnectionFactories

All the foreign connection factories associated with this foreign server.

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

ForeignDestinations

All the foreign destinations associated with this foreign server.

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

JNDIProperties

Any additional properties that must be set for the JNDI provider. These properties will be passed directly to the constructor for the JNDI provider's InitialContext class.

Some foreign providers require other properties to be set while obtaining an initial naming context. These properties can be set with a property bean.

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

Attributes

This section describes the following attributes:

CachingDisabled
ConnectionURL
DynamicallyCreated
Id
InitialContextFactory
JNDIPropertiesCredential
JNDIPropertiesCredentialEncrypted
MBeanInfo

Name
Notes
ObjectName
Parent
Registered
Tags
Type

CachingDisabled

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.

ConnectionURL

The URL that WebLogic Server will use to contact the JNDI provider. The syntax of this URL depends on which JNDI provider is being used. For WebLogic JMS, leave this field blank if you are referencing WebLogic JMS objects within the same cluster.

This value corresponds to the standard JNDI property, java.naming.provider.url.

Note: If this value is not specified, look-ups will be performed on the JNDI server within the WebLogic Server instance where this connection factory is deployed.

Privileges	Read/Write
Type	java.lang.String
Default Value	No-Override

DynamicallyCreated

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.

Id

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.

InitialContextFactory

The name of the class that must be instantiated to access the JNDI provider. This class name depends on the JNDI provider and the vendor that are being used.

This value corresponds to the standard JNDI property, java.naming.factory.initial.

Note: This value defaults to weblogic.jndi.WLInitialContextFactory, which is the correct value for WebLogic Server.

Privileges	Read/Write
Type	java.lang.String
Default Value	No-Override

JNDIPropertiesCredential

Any credentials that must be set for the JNDI provider. These credentials will be part of the properties passed directly to the constructor for the JNDI provider's InitialContext class.

Some foreign providers require other properties to be set while obtaining an initial naming context. These properties can be set with a property bean.

Privileges	Read/Write
Type	java.lang.String
Default Value	No-Override
Encrypted	true

JNDIPropertiesCredentialEncrypted

This should not be called by anyone. It's required when using the encrypted tag.

Privileges	Read/Write
Type	byte[]
Encrypted	true

MBeanInfo

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.

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.

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.

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

Privileges	Read/Write
Type

Registered

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.

Type

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.

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[]