ConnectorComponentRuntimeMBean

Overview  |   Related MBeans  |   Attributes  |   Operations

Overview

Generates notifications about the deployment state of resource adapters. (Each resource adapter is represented by an instance of ConnectorComponentMBean .)

In 2-phase deployment, if a resource adapter's state is PREPARED then it has achieved the first phase of deployment (everything is set up and all that remains is to enable a reference to the adapter). When the resource adapter is in an ACTIVATED state, it has achieved the second phase of deployment, in which applications can obtain a reference to the adapter.

A server instance creates an instance of this interface when it creates an instance of weblogic.management.configuration.ConnectorComponentMBean.

       
Since8.1.0.0
Fully Qualified Interface NameIf you use the getMBeanInfo operation in MBeanTypeServiceMBean, supply the following value as this MBean's fully qualified interface name:
weblogic.management.runtime.ConnectorComponentRuntimeMBean
Factory Methods No factory methods. Instances of this MBean are created automatically.
Access Points You can access this MBean from the following MBean attributes:
Access Points Inherited from ComponentRuntimeMBean Because this MBean extends or implements ComponentRuntimeMBean, you can also access this MBean by retrieving ComponentRuntimeMBeans. The following attributes contain ComponentRuntimeMBeans and its subtypes:
    Access Points Inherited from RuntimeMBean Because this MBean extends or implements RuntimeMBean, you can also access this MBean by retrieving RuntimeMBeans. The following attributes contain RuntimeMBeans and its subtypes:

    Related MBeans

    This section describes attributes that provide access to other MBeans.

    ConnectionPools

    An array of ConnectorConnectionPoolRuntimeMBeans, each of which represents the runtime data for a connection pool in the resource adapter.

    For more information, see:

           
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Privileges Read only
    TypeConnectorConnectionPoolRuntimeMBean[]
    Relationship type: Containment.

    ConnectorServiceRuntime

    Return the connector service runtime.

           
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Privileges Read only
    TypeConnectorServiceRuntimeMBean
    Relationship type: Containment.

    ConnectorWorkManagerRuntime

    Runtime information for adapter's work manager that beyond WebLogic's standard work manager. It provides addisional runtime information specific to Connector and not contained by WebLogic work manager.

    For more information, see:

           
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Privileges Read only
    TypeConnectorWorkManagerRuntimeMBean
    Relationship type: Containment.

    InboundConnections

    An array of runtime information for all inbound connections for the resource adapter.

           
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Privileges Read only
    TypeConnectorInboundRuntimeMBean[]
    Relationship type: Containment.

    Stats

           
    Privileges Read only
    TypeStats
    Relationship type: Reference.

    WorkManagerRuntime

    Runtime information for WebLogic's work manager that serves the adapter. It provides general runtime information by WebLogic work manager.

    For more information, see:

           
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Privileges Read only
    TypeWorkManagerRuntimeMBean
    Relationship type: Containment.

    WorkManagerRuntimes

    Get the runtime mbeans for all work managers defined in this component

           
    Factory Methods No explicit creator method. The child shares the lifecycle of its parent.
    Privileges Read only
    TypeWorkManagerRuntimeMBean[]
    Relationship type: Containment.

    Attributes

    This section describes the following attributes:

    ActiveVersion

    Return true if this version is the active version. Returns true if this resource adapter is not versioned.

           
    Privileges Read only
    Typeboolean

    ActiveVersionId

    Get the active version Id.

           
    Privileges Read only
    Typejava.lang.String

    AppDeploymentMBean

    Gets the AppDeploymentMBean for the Connector Component

    Deprecated. 9.1.0.0 Acquire this by looking up the AppDeploymentMBean with the same name as the parent ApplicationRuntime

           
    Privileges Read only
    Type

    CachingDisabled

    Private property that disables caching in proxies.

           
    Privileges Read only
    Typeboolean

    ComponentName

    Get the name of the connector component.

           
    Privileges Read only
    Typejava.lang.String

    Configuration

    Return the xml string representing the RA configuration. The xml corresponding to the latest schema is returned. The current supported version is "1.0"

           
    Privileges Read only
    Typejava.lang.String

    ConfigurationVersion

    Return the latest configuration version.

           
    Privileges Read only
    Typejava.lang.String

    ConfiguredProperties

    Gets a subset of the resource adapter descriptor information.

           
    Privileges Read only
    Typejava.util.Properties

    ConnectionPoolCount

    The number of connection pools.

           
    Privileges Read only
    Typeint

    ConnectorComponentMBean

    Gets the ConnectorComponentMBean for the Connector Component.

    Deprecated. 9.1.0.0 The connector component mbean was already deprecated.

           
    Privileges Read only
    Type

    DeploymentState

    The current deployment state of the module.

    A module can be in one and only one of the following states. State can be changed via deployment or administrator console.

    For more information, see:

           
    Privileges Read only
    Typeint

    Description

    Get the Description for the resource adapter.

           
    Privileges Read only
    Typejava.lang.String

    Descriptions

    Get the Descriptions for the resource adapter.

           
    Privileges Read only
    Typeclass java.lang.String[]

    EISResourceId

    Returns the EISResourceId for the component.

           
    Privileges Read only
    Typejava.lang.String

    EISType

    Get the EIS type.

           
    Privileges Read only
    Typejava.lang.String

    HealthState

    The HealthState mbean for the application.

    For more information, see:

           
    Available Since Release 12.1.2
    Privileges Read only
    Typeweblogic.health.HealthState

    InboundConnectionsCount

    The number of inbound connections for the resource adapter.

           
    Privileges Read only
    Typeint

    JndiName

    Get the Jndi name of the resource adapter.

           
    Privileges Read only
    Typejava.lang.String

    Linkref

    Get the linkref.

           
    Privileges Read only
    Typejava.lang.String

    MBeanInfo

    Returns the MBean info for this MBean.

    Deprecated.

           
    Privileges Read only
    Typejavax.management.MBeanInfo

    ModuleId

    Returns the identifier for this Component. The identifier is unique within the application.

    Typical modules will use the URI for their id. Web Modules will return their context-root since the web-uri may not be unique within an EAR.

           
    Privileges Read only
    Typejava.lang.String

    Name

    The name of this configuration. WebLogic Server uses an MBean to implement and persist the configuration.

           
    Privileges Read only
    Typejava.lang.String

    ObjectName

    Returns the ObjectName under which this MBean is registered in the MBean server.

    Deprecated.

           
    Privileges Read only
    Typeweblogic.management.WebLogicObjectName

    Parent

    Return the immediate parent for this MBean

           
    Privileges Read/Write
    Type

    Registered

    Returns false if the MBean represented by this object has been unregistered.

    Deprecated.

           
    Privileges Read only
    Typeboolean

    Schema

    Get the latest schema for RA configuration.

           
    Privileges Read only
    Typejava.lang.String

    SpecVersion

    Get the spec version.

           
    Privileges Read only
    Typejava.lang.String

    State

    Get the state of the resource adapter.

           
    Privileges Read only
    Typejava.lang.String

    SuspendedState

    Gets the suspended state information of the resource adapter.

    If getState() returns SUSPENDED then getSuspendedState() returns an integer describing which functions of the resource adapter are suspended: one or more of INBOUND, OUTBOUND or WORK (or ALL) or 0 for nothing suspended

    For more information, see:

           
    Privileges Read only
    Typeint

    Type

    Returns the type of the MBean.

           
    Privileges Read only
    Typejava.lang.String

    VendorName

    Get the vendor name.

           
    Privileges Read only
    Typejava.lang.String

    Version

    Get the version.

           
    Privileges Read only
    Typejava.lang.String

    Versioned

    Check if the resource adapter is versioned. Returns true if it is.

           
    Privileges Read only
    Typeboolean

    VersionId

    Get the version Id.

           
    Privileges Read only
    Typejava.lang.String

    Operations

    This section describes the following operations:

    getConfiguration

    Return the xml string representing the RA configuration. The xml corresponding to the version specified is returned.

       
    Operation Name"getConfiguration"
    ParametersObject [] {  version }

    where:

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

      String
    SignatureString [] { "java.lang.String" }
    ReturnsString

    getConnectionPool

    Returns a ConnectorConnectionPoolRuntimeMBean that represents the statistics for a connection pool. The pool that is accessed in this call must be part of the resource adapter that is being accessed. A null is returned if the JNDI name or resource-link name is not found.

    For more information, see:

       
    Operation Name"getConnectionPool"
    ParametersObject [] {  key }

    where:

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

      JNDI name or resource-link name of the connection pool.
    SignatureString [] { "java.lang.String" }
    ReturnsConnectorConnectionPoolRuntimeMBean

    getInboundConnection

    Runtime information for the specified inbound connection. A null is returned if the inbound connection is not found in the resource adapter.

       
    Operation Name"getInboundConnection"
    ParametersObject [] {  messageListenerType }

    where:

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

      Message listener type.
    SignatureString [] { "java.lang.String" }
    ReturnsConnectorInboundRuntimeMBean

    getSchema

    Get the schema for RA configuration based on the version that is provided. Return null if the version is not found. The current supported version is "1.0"

       
    Operation Name"getSchema"
    ParametersObject [] {  version }

    where:

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

      String
    SignatureString [] { "java.lang.String" }
    ReturnsString

    resume

    Resumes the specified type of activity for this resource adapter

       
    Operation Name"resume"
    ParametersObject [] {  type }

    where:

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

      int The type of activity(ies), @see weblogic.connector.extensions.Suspendable
    SignatureString [] { "java.lang.Integer" }
    Returns void
    Exceptions
    • weblogic.utils.ErrorCollectionException

    resume

    Resumes the specified type of activity for this resource adapter

       
    Operation Name"resume"
    ParametersObject [] {  type, props }

    where:

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

      int The type of activity(ies), @see weblogic.connector.extensions.Suspendable

    • props is an object of type java.util.Properties that specifies:

      Properties to pass on to the RA or null
    SignatureString [] { "java.lang.Integer", "java.util.Properties" }
    Returns void
    Exceptions
    • weblogic.utils.ErrorCollectionException

    resumeAll

    Resumes all activities of this resource adapter.

       
    Operation Name"resumeAll"
    Parametersnull
    Signaturenull
    Returns void
    Exceptions
    • weblogic.utils.ErrorCollectionException

    suspend

    Suspends the specified type of activity for this resource adapter

       
    Operation Name"suspend"
    ParametersObject [] {  type, props }

    where:

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

      int The type of activity(ies), @see weblogic.connector.extensions.Suspendable

    • props is an object of type java.util.Properties that specifies:

      Properties to pass on to the RA or null
    SignatureString [] { "java.lang.Integer", "java.util.Properties" }
    Returns void
    Exceptions
    • weblogic.utils.ErrorCollectionException

    suspend

    Suspend a particular type of activity for this resource adapter

       
    Operation Name"suspend"
    ParametersObject [] {  type }

    where:

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

      int The type of activity(ies), @see weblogic.connector.extensions.Suspendable
    SignatureString [] { "java.lang.Integer" }
    Returns void
    Exceptions
    • weblogic.utils.ErrorCollectionException

    suspendAll

    Resumes all activities of this resource adapter.

       
    Operation Name"suspendAll"
    Parametersnull
    Signaturenull
    Returns void
    Exceptions
    • weblogic.utils.ErrorCollectionException