Package weblogic.j2ee.descriptor.wl

Interface ForeignServerBean

All Superinterfaces:

NamedEntityBean, SettableBean, TargetableBean

public interface ForeignServerBean
extends TargetableBean

This bean represents foreign resources.

Access limited to the following security roles:

Deployer

Method Summary

Modifier and Type	Method	Description
ForeignConnectionFactoryBean	createForeignConnectionFactory(java.lang.String name)	Creates a foreign connection factory and adds it to this foreign server.
ForeignDestinationBean	createForeignDestination(java.lang.String name)	Creates a foreign destination and adds it to this foreign server
PropertyBean	createJNDIProperty(java.lang.String key)	Creates a JNDI property bean and adds it to this foreign server.
void	destroyForeignConnectionFactory(ForeignConnectionFactoryBean foreignConnectionFactory)	Removes a foreign connection factory from this foreign server.
void	destroyForeignDestination(ForeignDestinationBean foreignDestination)	Removes a foreign destination from this foreign server.
void	destroyJNDIProperty(PropertyBean jndiProperty)	Removes a JNDI property bean from this foreign server.
java.lang.String	getConnectionURL()	The URL that WebLogic Server will use to contact the JNDI provider.
ForeignConnectionFactoryBean[]	getForeignConnectionFactories()	Gets an array of all foreign connection factories associated with this foreign server.
ForeignDestinationBean[]	getForeignDestinations()	Gets an array of all foreign destinations associated with this foreign server.
java.lang.String	getInitialContextFactory()	The name of the class that must be instantiated to access the JNDI provider.
PropertyBean[]	getJNDIProperties()	Any additional properties that must be set for the JNDI provider.
java.lang.String	getJNDIPropertiesCredential()	Any Credentials that must be set for the JNDI provider.
byte[]	getJNDIPropertiesCredentialEncrypted()	This should not be called by anyone.
ForeignConnectionFactoryBean	lookupForeignConnectionFactory(java.lang.String name)	Finds a foreign connection factory bean with the given name.
ForeignDestinationBean	lookupForeignDestination(java.lang.String name)	Finds a foreign destination with the given name.
PropertyBean	lookupJNDIProperty(java.lang.String key)	Finds a JNDI Property with the given key.
void	setConnectionURL(java.lang.String connectionUrl)	Sets the value of the ConnectionURL attribute.
void	setInitialContextFactory(java.lang.String initialContextFactory)	Sets the value of the InitialContextFactory attribute.
void	setJNDIPropertiesCredential(java.lang.String value)
void	setJNDIPropertiesCredentialEncrypted(byte[] eBytes)

Methods inherited from interface weblogic.j2ee.descriptor.wl.NamedEntityBean

getId, getName, getNotes, setName, setNotes

Methods inherited from interface weblogic.j2ee.descriptor.wl.TargetableBean

getSubDeploymentName, isDefaultTargetingEnabled, setDefaultTargetingEnabled, setSubDeploymentName

Method Detail

getForeignDestinations

ForeignDestinationBean[] getForeignDestinations()

Gets an array of all foreign destinations associated with this foreign server.

Returns:

An array of all foreign destinations associated with this foreign server

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

createForeignDestination

ForeignDestinationBean createForeignDestination(java.lang.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(ForeignDestinationBean foreignDestination)

Removes a foreign destination from this foreign server.

Parameters:

foreignDestination - The specific destination to remove from this foreign server

lookupForeignDestination

ForeignDestinationBean lookupForeignDestination(java.lang.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

ForeignConnectionFactoryBean[] getForeignConnectionFactories()

Gets an array of all foreign connection factories associated with this foreign server.

Returns:

An array of all foreign connection factories associated with this foreign server

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

createForeignConnectionFactory

ForeignConnectionFactoryBean createForeignConnectionFactory(java.lang.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(ForeignConnectionFactoryBean foreignConnectionFactory)

Removes a foreign connection factory from this foreign server.

Parameters:

foreignConnectionFactory - The specific factory to remove from this foreign server

lookupForeignConnectionFactory

ForeignConnectionFactoryBean lookupForeignConnectionFactory(java.lang.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

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

Default Value:

weblogic.j2ee.descriptor.wl.constants.JMSConstants.INITIALCONTEXTFACTORY

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setInitialContextFactory

void setInitialContextFactory(java.lang.String initialContextFactory)
                       throws java.lang.IllegalArgumentException

Sets the value of the InitialContextFactory attribute.

Parameters:

initialContextFactory - The new initialContextFactory value

Throws:

java.lang.IllegalArgumentException

See Also:

getInitialContextFactory()

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

This property cannot have a value of length zero.

getConnectionURL

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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setConnectionURL

void setConnectionURL(java.lang.String connectionUrl)
               throws java.lang.IllegalArgumentException

Sets the value of the ConnectionURL attribute.

Parameters:

connectionUrl - The new connectionURL value

Throws:

java.lang.IllegalArgumentException - 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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setJNDIPropertiesCredentialEncrypted

void setJNDIPropertiesCredentialEncrypted(byte[] eBytes)

getJNDIPropertiesCredential

java.lang.String getJNDIPropertiesCredential()

Any Credentials that must be set for the JNDI provider. These Credentials will be part of the 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:

A byte array of the Credential associated with this foreign server

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

setJNDIPropertiesCredential

void setJNDIPropertiesCredential(java.lang.String value)

getJNDIProperties

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

Changes to this property are dynamic and thus take effect immediately without restarting the server or partition.

createJNDIProperty

PropertyBean createJNDIProperty(java.lang.String key)

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:

key - The key of the property to add to this foreign server

Returns:

The property bean added to this foreign server

destroyJNDIProperty

void destroyJNDIProperty(PropertyBean 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

PropertyBean lookupJNDIProperty(java.lang.String key)

Finds a JNDI Property with the given key.

Parameters:

key - name The name of the JNDIProperty to find

Returns:

A JNDI Property with the given key, or null if one could not be found