weblogic.management.runtime
Interface ConnectorComponentRuntimeMBean

All Superinterfaces:

ComponentRuntimeMBean, DynamicMBean, HealthFeedback, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, WebLogicMBean

public interface ConnectorComponentRuntimeMBean
extends ComponentRuntimeMBean, HealthFeedback

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.

NEW

static final String NEW

Resource adapter state definition

INITIALIZED

static final String INITIALIZED

Resource adapter state definition

PREPARED

static final String PREPARED

Resource adapter state definition

ACTIVATED

static final String ACTIVATED

Resource adapter state definition

SUSPENDED

static final String SUSPENDED

state definition. Indicates RA is partially or wholly suspended see suspend state for full condition.

getConnectionPoolCount

int getConnectionPoolCount()

The number of connection pools.

Returns:

Count of the number of connection pools.

getConnectionPools

ConnectorConnectionPoolRuntimeMBean[] getConnectionPools()

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

Returns:

An array of ConnectorConnectionPoolRuntimeMBean objects.

See Also:

ConnectorConnectionPoolRuntimeMBean

getConnectionPool

ConnectorConnectionPoolRuntimeMBean getConnectionPool(String key)

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.

Parameters:

key - JNDI name or resource-link name of the connection pool.

Returns:

A ConnectorConnectionPoolRuntimeMBean object.

See Also:

ConnectorConnectionPoolRuntimeMBean

getInboundConnectionsCount

int getInboundConnectionsCount()

The number of inbound connections for the resource adapter.

Returns:

Count of the number of inbound connections.

getInboundConnections

ConnectorInboundRuntimeMBean[] getInboundConnections()

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

Returns:

An array of ConnectorInboundRuntimeMBean objects.

getInboundConnection

ConnectorInboundRuntimeMBean getInboundConnection(String messageListenerType)

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

Parameters:

messageListenerType - Message listener type.

Returns:

A ConnectorInboundRuntimeMBean object.

getEISResourceId

String getEISResourceId()

Returns the EISResourceId for the component.

Returns:

The eisResourceId attribute for the resource adapter.

suspendAll

void suspendAll()
                throws ErrorCollectionException

Resumes all activities of this resource adapter.

Throws:

ErrorCollectionException - if something goes wrong

suspend

void suspend(int type)
             throws ErrorCollectionException

Suspend a particular type of activity for this resource adapter

Parameters:

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

Throws:

ErrorCollectionException - if something goes wrong

suspend

void suspend(int type,
             Properties props)
             throws ErrorCollectionException

Suspends the specified type of activity for this resource adapter

Parameters:

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

props - Properties to pass on to the RA or null

Throws:

ErrorCollectionException - if something goes wrong

resumeAll

void resumeAll()
               throws ErrorCollectionException

Resumes all activities of this resource adapter.

Throws:

ErrorCollectionException - if something goes wrong

resume

void resume(int type)
            throws ErrorCollectionException

Resumes the specified type of activity for this resource adapter

Parameters:

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

Throws:

ErrorCollectionException - if something goes wrong

resume

void resume(int type,
            Properties props)
            throws ErrorCollectionException

Resumes the specified type of activity for this resource adapter

Parameters:

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

props - Properties to pass on to the RA or null

Throws:

ErrorCollectionException - if something goes wrong

getConfiguredProperties

Properties getConfiguredProperties()

Gets a subset of the resource adapter descriptor information.

getAppDeploymentMBean

AppDeploymentMBean getAppDeploymentMBean()

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

Gets the AppDeploymentMBean for the Connector Component

getConnectorComponentMBean

ConnectorComponentMBean getConnectorComponentMBean()

Deprecated. 9.1.0.0 The connector component mbean was already deprecated.

Gets the ConnectorComponentMBean for the Connector Component.

getConnectorServiceRuntime

ConnectorServiceRuntimeMBean getConnectorServiceRuntime()

Return the connector service runtime.

Returns:

ConnectorServiceRuntimeMBean

getVersionId

String getVersionId()

Get the version Id.

Returns:

String

getActiveVersionId

String getActiveVersionId()

Get the active version Id.

Returns:

String

isVersioned

boolean isVersioned()

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

Returns:

boolean

isActiveVersion

boolean isActiveVersion()

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

Returns:

boolean

getJndiName

String getJndiName()

Get the Jndi name of the resource adapter.

Returns:

String

getState

String getState()

Get the state of the resource adapter.

Returns:

String one of (localized) NEW, INITIALIZED, PREPARED, ACTIVATED, SUSPENDED

getSuspendedState

int getSuspendedState()

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

Returns:

int (Suspendable.INBOUND | Suspendable.OUTBOUND | Suspendable.WORK | Suspendable.ALL )

See Also:

Suspendable

getSchema

String getSchema()

Get the latest schema for RA configuration.

Returns:

String

getSchema

String getSchema(String version)

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"

Parameters:

version - String

Returns:

String

getConfigurationVersion

String getConfigurationVersion()

Return the latest configuration version.<.p>

Returns:

String

getConfiguration

String getConfiguration()

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

Returns:

String

getConfiguration

String getConfiguration(String version)

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

Parameters:

version - String

Returns:

String

getDescription

String getDescription()

Get the Description for the resource adapter.

Returns:

String

getDescriptions

String[] getDescriptions()

Get the Descriptions for the resource adapter.

Returns:

String[]

getEISType

String getEISType()

Get the EIS type.

Returns:

String

getSpecVersion

String getSpecVersion()

Get the spec version.

Returns:

String

getVendorName

String getVendorName()

Get the vendor name.

Returns:

String

getVersion

String getVersion()

Get the version.

Returns:

String

getLinkref

String getLinkref()

Get the linkref.

Returns:

String

getComponentName

String getComponentName()

Get the name of the connector component.

Returns:

String

getWorkManagerRuntime

WorkManagerRuntimeMBean getWorkManagerRuntime()

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

Returns:

A WorkManagerRuntimeMBean object.

See Also:

WorkManagerRuntimeMBean

getConnectorWorkManagerRuntime

ConnectorWorkManagerRuntimeMBean getConnectorWorkManagerRuntime()

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.

Returns:

A ConnectorWorkManagerRuntimeMBean object.

See Also:

ConnectorWorkManagerRuntimeMBean

getHealthState

HealthState getHealthState()

The HealthState mbean for the application.

Specified by:

getHealthState in interface HealthFeedback

Returns:

HealthState the health state information for this adapter.

See Also:

HealthState