ForeignServerBean

Overview  |   Child MBeans  |   Attributes  |   Operations

Overview

This bean represents foreign resources.

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.j2ee.descriptor.wl.ForeignServerBean

Factory Methods

Additional Access Points

In addition to accessing this MBean by invoking a factory method, you can also access this MBean from the following MBean attributes:

    Child MBeans

    This section describes attributes that contain child MBeans. For more information about the MBean hierarchy, refer to WebLogic Server MBean Data Model.

    ForeignConnectionFactories

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

               
    Factory MethodscreateForeignConnectionFactory (java.lang.String name)

    destroyForeignConnectionFactory (ForeignConnectionFactoryBean foreignConnectionFactory)

    Factory methods do not return objects.

    See Using factory methods.
    Lookup OperationlookupForeignConnectionFactory(String name)

    Returns a javax.management.ObjectName for the instance of ForeignConnectionFactoryBean named name.
    Privileges Read only
    TypeForeignConnectionFactoryBean[]

    ForeignDestinations

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

               
    Factory MethodscreateForeignDestination (java.lang.String name)

    destroyForeignDestination (ForeignDestinationBean foreignDestination)

    Factory methods do not return objects.

    See Using factory methods.
    Lookup OperationlookupForeignDestination(String name)

    Returns a javax.management.ObjectName for the instance of ForeignDestinationBean named name.
    Privileges Read only
    TypeForeignDestinationBean[]

    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 MethodscreateJNDIProperty (java.lang.String key)

    destroyJNDIProperty (PropertyBean jndiProperty)

    Factory methods do not return objects.

    See Using factory methods.
    Privileges Read only
    TypePropertyBean[]

    Attributes

    This section describes the following attributes:

    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
    Typejava.lang.String

    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
    Typejava.lang.String
    Default Valueweblogic.jndi.WLInitialContextFactory

    Name

    The name of this entity, represented in XML as a attribute

    Many of the elements within the JMS module are named entities. All of the named entities encased by a type in the XML file must be unique. This is the identifier used to delineate a particular entity within the JMS module.

    This attribute cannot be modified externally from the module (for example with a deployment plan) because it may be used inside the module referentially.

           
    Privileges Read/Write
    Typejava.lang.String
    Redeploy or Restart required Changes take effect after you redeploy the module or restart the server.

    Notes

    Optional information that you can include to describe this named JMS descriptor bean.

    JMS module saves this note in the JMS descriptor file as XML PCDATA. All left angle brackets (<) are converted to the XML entity &lt;. 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
    Typejava.lang.String

    SubDeploymentName

    Gets the name of the sub-deployment to use when targeting this entity

    Entities are targeted using a sub-deployment with this name. The targets of the sub-deployment will be the targets of this entity.

           
    Privileges Read/Write
    Typejava.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:

      isSet

      Return true if the given property has been explicitly set in this bean.

         
      Operation Name"isSet"
      ParametersObject [] {  propertyName }

      where:

      • propertyName is an object of type java.lang.String that specifies:

        property to check
      SignatureString [] { "java.lang.String" }
      Returns boolean

      Exceptions

      unSet

      Restore the given property to its default value.

         
      Operation Name"unSet"
      ParametersObject [] {  propertyName }

      where:

      • propertyName is an object of type java.lang.String that specifies:

        property to restore
      SignatureString [] { "java.lang.String" }
      Returns void

      Exceptions