BEA Systems, Inc.

Type-Safe Access to BEA WebLogic Server 9.0 MBeans (Deprecated)

(Methods marked with @since 9.0.0.0 are not available through the deprecated MBeanHome interface.)


weblogic.management.configuration
Interface BridgeDestinationCommonMBean

All Superinterfaces:
ConfigurationMBean, weblogic.descriptor.DescriptorBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, weblogic.descriptor.SettableBean, weblogic.management.WebLogicMBean
All Known Subinterfaces:
BridgeDestinationMBean, JMSBridgeDestinationMBean

public interface BridgeDestinationCommonMBean
extends ConfigurationMBean

This MBean represents a bridge destination for a messaging bridge instance. Each messaging bridge instance consists of the following destination types:

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/documentation/index.html.

Since:
7.0.0.0
Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Field Summary
static String JMS_XA_ADAPTER_JNDI
           
 
Fields inherited from interface weblogic.management.configuration.ConfigurationMBean
DEFAULT_EMPTY_BYTE_ARRAY
 
Method Summary
 String getAdapterJNDIName()
          The JNDI name of the adapter used to communicate with the specified destination.
 String getClasspath()
          The CLASSPATH of the bridge destination.
 String getUserName()
          The optional user name the adapter uses to access the bridge destination.
 String getUserPassword()
          The user password that the adapter uses to access the bridge destination.
 byte[] getUserPasswordEncrypted()
          The encrypted user password that the adapter uses to access the bridge destination.
 void setAdapterJNDIName(String name)
          Sets the value of the AdapterJNDIName attribute.
 void setClasspath(String classpath)
          Sets the value of the Classpath attribute.
 void setUserName(String name)
          Sets the value of the UserName attribute.
 void setUserPassword(String password)
          Encrypts the password and sets the value of the UserPassword attribute and the UserPasswordEncrypted attribute.
 void setUserPasswordEncrypted(byte[] passwordEncrypted)
          Sets the encrypted value of the UserPassword attribute.
 
Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
freezeCurrentValue, getName, getNotes, 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
addBeanUpdateListener, addPropertyChangeListener, createChildCopy, createChildCopyIncludingObsolete, getDescriptor, getParentBean, isEditable, removeBeanUpdateListener, removePropertyChangeListener
 

Field Detail

JMS_XA_ADAPTER_JNDI

public static final String JMS_XA_ADAPTER_JNDI
See Also:
Constant Field Values
Method Detail

getAdapterJNDIName

public String getAdapterJNDIName()

The JNDI name of the adapter used to communicate with the specified destination.

This name is specified in the adapter's deployment descriptor file and is used by the WebLogic Server Connector container to bind the adapter in WebLogic Server JNDI.

Returns:
The adapterJNDIName value

getClasspath

public String getClasspath()

The CLASSPATH of the bridge destination.

Returns:
The classpath value

getUserName

public String getUserName()

The optional user name the adapter uses to access the bridge destination.

All operations on the specified destination are done using this user name and the corresponding password. Therefore, the User Name/Password for the source and target destinations must have permission to the access the underlying destinations in order for the messaging bridge to work.

Returns:
The userName value

getUserPassword

public String getUserPassword()

The user password that the adapter uses to access the bridge destination.

As of 8.1 sp4, when you get the value of this attribute, WebLogic Server does the following:

  1. Retrieves the value of the UserPasswordEncrypted attribute.
  2. Decrypts the value and returns the unencrypted password as a String.

When you set the value of this attribute, WebLogic Server does the following:

  1. Encrypts the value.
  2. Sets the value of the UserPasswordEncrypted attribute to the encrypted value.

Using this attribute (UserPassword) is a potential security risk because the String object (which contains the unencrypted password) remains in the JVM's memory until garbage collection removes it. Depending on how memory is allocated in the JVM, a significant amount of time could pass before this unencrypted data is removed from memory.

Instead of using this attribute, use UserPasswordEncrypted.

Returns:
The userPassword value
See Also:
getUserPasswordEncrypted()

getUserPasswordEncrypted

public byte[] getUserPasswordEncrypted()

The encrypted user password that the adapter uses to access the bridge destination.

To set this attribute, pass an unencrypted string to the MBean server's setAttribute method. WebLogic Server encrypts the value and sets the attribute to the encrypted value.

To compare a password that a user enters with the encrypted value of this attribute, go to the same WebLogic Server instance that you used to set and encrypt this attribute and use weblogic.management.EncryptionHelper.encrypt() to encrypt the user-supplied password. Then compare the encrypted values.

Returns:
The UserPasswordEncrypted value as an encrypted byte array
See Also:
weblogic.management.EncryptionHelper

setAdapterJNDIName

public void setAdapterJNDIName(String name)
                        throws InvalidAttributeValueException

Sets the value of the AdapterJNDIName attribute.

Parameters:
name - The new adapterJNDIName value
Throws:
InvalidAttributeValueException
See Also:
getAdapterJNDIName()
Default value:
BridgeDestinationCommonMBean.JMS_XA_ADAPTER_JNDI
Legal null:
false
A dynamic MBean attribute.
false

setClasspath

public void setClasspath(String classpath)
                  throws InvalidAttributeValueException

Sets the value of the Classpath attribute.

Parameters:
classpath - The new classpath value
Throws:
InvalidAttributeValueException
See Also:
getClasspath()
A dynamic MBean attribute.
false

setUserName

public void setUserName(String name)
                 throws InvalidAttributeValueException

Sets the value of the UserName attribute.

Parameters:
name - The new userName value
Throws:
InvalidAttributeValueException
See Also:
getUserName()
A dynamic MBean attribute.
false

setUserPassword

public void setUserPassword(String password)
                     throws InvalidAttributeValueException

Encrypts the password and sets the value of the UserPassword attribute and the UserPasswordEncrypted attribute.

Parameters:
password - The new userPassword value
Throws:
InvalidAttributeValueException
See Also:
getUserPassword(), getUserPasswordEncrypted()
A dynamic MBean attribute.
false

setUserPasswordEncrypted

public void setUserPasswordEncrypted(byte[] passwordEncrypted)

Sets the encrypted value of the UserPassword attribute.

Parameters:
passwordEncrypted - The new encrypted value
See Also:
getUserPasswordEncrypted()
A dynamic MBean attribute.
false

Documentation is available at
http://download.oracle.com/docs/cd/E13222_01/wls/docs90
Copyright 2005 BEA Systems Inc.