Skip navigation links

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09


weblogic.management.configuration
Interface ForeignServerOverrideMBean

All Superinterfaces:
ConfigurationMBean, DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, SettableBean, WebLogicMBean

public interface ForeignServerOverrideMBean
extends ConfigurationMBean

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

Field Summary

 

Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY

 

Method Summary
abstract  ForeignConnectionFactoryOverrideMBean createForeignConnectionFactory(String name)
          Creates a foreign connection factory and adds it to this foreign server.
abstract  ForeignDestinationOverrideMBean createForeignDestination(String name)
          Creates a foreign destination and adds it to this foreign server.
abstract  PartitionPropertyMBean createJNDIProperty(String name)
          Creates a JNDI property bean and adds it to this foreign server.
abstract  void destroyForeignConnectionFactory(ForeignConnectionFactoryOverrideMBean foreignConnectionFactory)
          Removes a foreign connection factory from this foreign server.
abstract  void destroyForeignDestination(ForeignDestinationOverrideMBean foreignDestination)
          Removes a foreign destination from this foreign server.
abstract  void destroyJNDIProperty(PartitionPropertyMBean jndiProperty)
          Removes a JNDI property bean from this foreign server.
abstract  String getConnectionURL()
          The URL that WebLogic Server will use to contact the JNDI provider.
abstract  ForeignConnectionFactoryOverrideMBean[] getForeignConnectionFactories()
          All the foreign connection factories associated with this foreign server.
abstract  ForeignDestinationOverrideMBean[] getForeignDestinations()
          All the foreign destinations associated with this foreign server.
abstract  String getInitialContextFactory()
          The name of the class that must be instantiated to access the JNDI provider.
abstract  PartitionPropertyMBean[] getJNDIProperties()
          Any additional properties that must be set for the JNDI provider.
abstract  String getJNDIPropertiesCredential()
          Any credentials that must be set for the JNDI provider.
abstract  byte[] getJNDIPropertiesCredentialEncrypted()
           This should not be called by anyone.
abstract  ForeignConnectionFactoryOverrideMBean lookupForeignConnectionFactory(String name)
          Finds a foreign connection factory bean with the given name.
abstract  ForeignDestinationOverrideMBean lookupForeignDestination(String name)
          Finds a foreign destination with the given name.
abstract  PartitionPropertyMBean lookupJNDIProperty(String name)
          Finds a JNDI property with the given key.
abstract  void setConnectionURL(String connectionUrl)
          Sets the value of the ConnectionURL attribute.
abstract  void setInitialContextFactory(String initialContextFactory)
          Sets the value of the InitialContextFactory attribute.
abstract  void setJNDIPropertiesCredential(String value)
          This overrides the setting of the corresponding MBean that is defined in a resource group template.
abstract  void setJNDIPropertiesCredentialEncrypted(byte[] eBytes)
          This overrides the setting of the corresponding MBean that is defined in a resource group template.

 

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getId, getInheritedProperties, getName, getNotes, isDynamicallyCreated, isInherited, isSet, restoreDefaultValue, setComments, setDefaultedMBean, setName, setNotes, setPersistenceEnabled, unSet

 

Methods inherited from interface weblogic.management.WebLogicMBean
getMBeanInfo, getObjectName, getParent, getType, isCachingDisabled, isRegistered, setParent

 

Methods inherited from interface javax.management.DynamicMBean
getAttribute, getAttributes, invoke, setAttribute, setAttributes

 

Methods inherited from interface javax.management.MBeanRegistration
postDeregister, postRegister, preDeregister, preRegister

 

Methods inherited from interface javax.management.NotificationBroadcaster
addNotificationListener, getNotificationInfo, removeNotificationListener

 

Methods inherited from interface weblogic.descriptor.DescriptorBean
addPropertyChangeListener, createChildCopyIncludingObsolete, getParentBean, isEditable, removePropertyChangeListener

 

Method Detail

getForeignDestinations

ForeignDestinationOverrideMBean[] getForeignDestinations()
All the foreign destinations associated with this foreign server.
Returns:
An array of all foreign destinations associated with this foreign server

createForeignDestination

ForeignDestinationOverrideMBean createForeignDestination(String name)
Creates a foreign destination and adds it to this foreign server.
Parameters:
name - The name of the foreign destination to add to this foreign server.
Returns:
The foreign destination added to this foreign server

destroyForeignDestination

void destroyForeignDestination(ForeignDestinationOverrideMBean foreignDestination)
Removes a foreign destination from this foreign server.
Parameters:
foreignDestination - The specific destination to remove from this foreign server

lookupForeignDestination

ForeignDestinationOverrideMBean lookupForeignDestination(String name)
Finds a foreign destination with the given name.
Parameters:
name - The name of the destination to find
Returns:
A foreign destination with the given name, or null if one could not be found

getForeignConnectionFactories

ForeignConnectionFactoryOverrideMBean[] getForeignConnectionFactories()
All the foreign connection factories associated with this foreign server.
Returns:
An array of all foreign connection factories associated with this foreign server

createForeignConnectionFactory

ForeignConnectionFactoryOverrideMBean createForeignConnectionFactory(String name)
Creates a foreign connection factory and adds it to this foreign server.
Parameters:
name - The name of the foreign connection factory to add to this foreign server
Returns:
The foreign connection factory added to this foreign server

destroyForeignConnectionFactory

void destroyForeignConnectionFactory(ForeignConnectionFactoryOverrideMBean foreignConnectionFactory)
Removes a foreign connection factory from this foreign server.
Parameters:
foreignConnectionFactory - The specific factory to remove from this foreign server

lookupForeignConnectionFactory

ForeignConnectionFactoryOverrideMBean lookupForeignConnectionFactory(String name)
Finds a foreign connection factory bean with the given name.
Parameters:
name - The name of the foreign connection factory to find
Returns:
A foreign connection factory bean with the given name, or null if one is not found

getInitialContextFactory

String getInitialContextFactory()

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.

Returns:
The initialContextFactory value

setInitialContextFactory

void setInitialContextFactory(String initialContextFactory)
                              throws InvalidAttributeValueException

Sets the value of the InitialContextFactory attribute.

This overrides the setting of the corresponding MBean that is defined in a resource group template.
Parameters:
initialContextFactory - The new initialContextFactory value
Throws:
InvalidAttributeValueException
See Also:
ForeignServerOverrideMBean.getInitialContextFactory()

getConnectionURL

String getConnectionURL()

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.

Returns:
The connectionURL value

setConnectionURL

void setConnectionURL(String connectionUrl)
                      throws InvalidAttributeValueException

Sets the value of the ConnectionURL attribute.

This overrides the setting of the corresponding MBean that is defined in a resource group template.
Parameters:
connectionUrl - The new connectionURL value
Throws:
InvalidAttributeValueException - If the argument is not legal

getJNDIPropertiesCredentialEncrypted

byte[] getJNDIPropertiesCredentialEncrypted()

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

Returns:
A byte array of the Credential associated with this foreign server

setJNDIPropertiesCredentialEncrypted

void setJNDIPropertiesCredentialEncrypted(byte[] eBytes)
This overrides the setting of the corresponding MBean that is defined in a resource group template.

getJNDIPropertiesCredential

String getJNDIPropertiesCredential()

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.

Returns:
A byte array of the Credential associated with this foreign server

setJNDIPropertiesCredential

void setJNDIPropertiesCredential(String value)
This overrides the setting of the corresponding MBean that is defined in a resource group template.

getJNDIProperties

PartitionPropertyMBean[] getJNDIProperties()

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.

Returns:
An array of all JNDI properties associated with this foreign server

createJNDIProperty

PartitionPropertyMBean createJNDIProperty(String name)
Creates a JNDI property bean and adds it to this foreign server.

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

Parameters:
name - The name of the property MBean to add to this foreign server
Returns:
The property bean added to this foreign server

destroyJNDIProperty

void destroyJNDIProperty(PartitionPropertyMBean jndiProperty)
Removes a JNDI property bean from this foreign server.

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

Parameters:
jndiProperty - The property to remove from this foreign server

lookupJNDIProperty

PartitionPropertyMBean lookupJNDIProperty(String name)
Finds a JNDI property with the given key.
Parameters:
name - The name of the JNDIProperty to find
Returns:
A JNDI Property with the given key, or null if one could not be found

Skip navigation links

Copyright 1996, 2015, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.2.1)

Part Number E55141-01
P4 Change 1723563 on 2015/10/09