ForeignJNDIProviderMBean (Java API Reference for Oracle WebLogic Server)

Class

Use

Tree

Help

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

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

weblogic.management.configuration
Interface ForeignJNDIProviderMBean

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

public interface ForeignJNDIProviderMBean

extends DeploymentMBean

This class represents a JNDI provider that is outside the WebLogic server.

Field Summary

Fields inherited from interface weblogic.management.configuration.DeploymentMBean
`DEFAULT_ORDER, MAX_ORDER, MIN_ORDER`

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

Method Summary
`abstract ForeignJNDILinkMBean`	`createForeignJNDILink(String name)` Create a ForeignJNDILink resource with the given name.
`abstract void`	`destroyForeignJNDILink(ForeignJNDILinkMBean bean)` Destroy the given ForeignJNDILink resource.
`abstract ForeignJNDILinkMBean[]`	`getForeignJNDILinks()` The foreign links.
`abstract String`	`getInitialContextFactory()` The initial context factory to use to connect.
`abstract String`	`getName()` The user-specified name of this MBean instance.
`abstract String`	`getPassword()` The remote server's user password.
`abstract byte[]`	`getPasswordEncrypted()` The remote server's encrypted user password.
`abstract Properties`	`getProperties()` Any additional properties that must be set for the JNDI provider.
`abstract String`	`getProviderURL()` The foreign JNDI provider URL.
`abstract String`	`getUser()` The remote server's user name.
`abstract ForeignJNDILinkMBean`	`lookupForeignJNDILink(String name)` Find a ForeignJNDILink resource with the given name.
`abstract void`	`setInitialContextFactory(String ic)` The initial context factory used to connect.
`abstract void`	`setPassword(String password)` The password used to connect.
`abstract void`	`setPasswordEncrypted(byte[] encryptedPassword)` The encrypted password to connect.
`abstract void`	`setProperties(Properties params)` Sets the value of the JNDIProperties attribute.
`abstract void`	`setProviderURL(String url)` The initial context factory used to connect.
`abstract void`	`setUser(String user)` The user name used to connect.

Methods inherited from interface weblogic.management.configuration.DeploymentMBean
`addTarget, getDeploymentOrder, getTargets, removeTarget, setDeploymentOrder, setTargets`

Methods inherited from interface weblogic.management.configuration.ConfigurationMBean
`freezeCurrentValue, getId, getInheritedProperties, 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

getName

String getName()

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

Specified by:: getName in interface ConfigurationMBean
Specified by:: getName in interface WebLogicMBean

getInitialContextFactory

String getInitialContextFactory()

The initial context factory to use to connect. This class name depends on the JNDI provider and the vendor you are using. The value corresponds to the standard JNDI property, java.naming.factory.initial.

Returns:: The initial context factory value

setInitialContextFactory

void setInitialContextFactory(String ic)
                              throws InvalidAttributeValueException

The initial context factory used to connect.

Parameters:: ic - The initial context factory value.
Throws:: InvalidAttributeValueException

getProviderURL

String getProviderURL()

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

Returns:: The foreign JNDI provider URL.

setProviderURL

void setProviderURL(String url)
                    throws InvalidAttributeValueException

The initial context factory used to connect.

Parameters:: url - The Provider URL.
Throws:: InvalidAttributeValueException

getPassword

String getPassword()

The remote server's user password.

Returns:: The foreign JNDI provider password.

setPassword

void setPassword(String password)
                 throws InvalidAttributeValueException

The password used to connect.

Parameters:: password - The user password.
Throws:: InvalidAttributeValueException

getPasswordEncrypted

byte[] getPasswordEncrypted()

The remote server's encrypted user password.

Returns:: The foreign JNDI provider encrypted password as a byte array.

setPasswordEncrypted

void setPasswordEncrypted(byte[] encryptedPassword)
                          throws InvalidAttributeValueException

The encrypted password to connect.

Parameters:: encryptedPassword - encrypted user password as a byte array.
Throws:: InvalidAttributeValueException

getUser

String getUser()

The remote server's user name.

Returns:: The foreign JNDI provider user name.

setUser

void setUser(String user)
             throws InvalidAttributeValueException

The user name used to connect.

Parameters:: user - The user name
Throws:: InvalidAttributeValueException

getForeignJNDILinks

ForeignJNDILinkMBean[] getForeignJNDILinks()

The foreign links.

Returns:: foreign links.
Since:: 9.0.0.0

lookupForeignJNDILink

ForeignJNDILinkMBean lookupForeignJNDILink(String name)

Find a ForeignJNDILink resource with the given name.

Parameters:: name - Name of the foreign JNDI link
Returns:: foreign link.
Since:: 9.0.0.0

createForeignJNDILink

ForeignJNDILinkMBean createForeignJNDILink(String name)

Create a ForeignJNDILink resource with the given name.

Parameters:: name - Name of the foreign JNDI link
Returns:: foreign link.
Since:: 9.0.0.0

destroyForeignJNDILink

void destroyForeignJNDILink(ForeignJNDILinkMBean bean)

Destroy the given ForeignJNDILink resource.

Parameters:: bean - foreign link
Since:: 9.0.0.0

setProperties

void setProperties(Properties params)
                   throws InvalidAttributeValueException

Sets the value of the JNDIProperties attribute.

Parameters:: params - The new jNDIProperties value
Throws:: InvalidAttributeValueException
See Also:: ForeignJNDIProviderMBean.getProperties()

getProperties

Properties getProperties()

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.

Note: This value must be filled in using a name=value<return>name=value format.

Returns:: The jNDIProperties value

Overview

Package