Type-Safe Access to BEA WebLogic Server 9.0 MBeans (Deprecated)

weblogic.management.runtime
Interface ConnectorComponentRuntimeMBean

All Superinterfaces:

ComponentRuntimeMBean, DynamicMBean, MBeanRegistration, NotificationBroadcaster, weblogic.management.runtime.RuntimeMBean, WebLogicMBean

public interface ConnectorComponentRuntimeMBean

extends ComponentRuntimeMBean

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.

Deprecation of MBeanHome and Type-Safe Interfaces

This is a type-safe interface for a WebLogic Server MBean, which you can import into your client classes and access through weblogic.management.MBeanHome. As of 9.0, the MBeanHome interface and all type-safe interfaces for WebLogic Server MBeans are deprecated. Instead, client classes that interact with WebLogic Server MBeans should use standard JMX design patterns in which clients use the javax.management.MBeanServerConnection interface to discover MBeans, attributes, and attribute types at runtime. For more information, see "Developing Manageable Applications with JMX" on http://www.oracle.com/technology/documentation/index.html.

Since:

8.1.0.0

Copyright © 2005 BEA Systems, Inc. All Rights Reserved.

Field Summary

static String	ACTIVATED Resource adapter state definition
static String	INITIALIZED Resource adapter state definition
static String	NEW Resource adapter state definition
static String	PREPARED Resource adapter state definition
static String	SUSPENDED state definition.

Fields inherited from interface weblogic.management.runtime.ComponentRuntimeMBean

UNPREPARED

Method Summary

String	getActiveVersionId() Get the active version Id.
weblogic.management.configuration.AppDeploymentMBean	getAppDeploymentMBean() Gets the AppDeploymentMBean for the Connector Component
String	getComponentName() Get the name of the connector component.
String	getConfiguration() Return the xml string representing the RA configuration.
String	getConfiguration(String version) Return the xml string representing the RA configuration.
String	getConfigurationVersion() Return the latest configuration version.<.p>
Properties	getConfiguredProperties() Gets a subset of the resource adapter descriptor information.
ConnectorConnectionPoolRuntimeMBean	getConnectionPool(String key) Returns a ConnectorConnectionPoolRuntimeMBean that represents the statistics for a connection pool.
int	getConnectionPoolCount() The number of connection pools.
ConnectorConnectionPoolRuntimeMBean[]	getConnectionPools() An array of ConnectorConnectionPoolRuntimeMBeans, each of which represents the runtime data for a connection pool in the resource adapter.
ConnectorComponentMBean	getConnectorComponentMBean() Gets the ConnectorComponentMBean for the Connector Component.
ConnectorServiceRuntimeMBean	getConnectorServiceRuntime() Return the connector service runtime.
String	getDescription() Get the Description for the resource adapter.
String[]	getDescriptions() Get the Descriptions for the resource adapter.
String	getEISResourceId() Returns the EISResourceId for the component.
String	getEISType() Get the EIS type.
ConnectorInboundRuntimeMBean	getInboundConnection(String messageListenerType) Runtime information for the specified inbound connection.
ConnectorInboundRuntimeMBean[]	getInboundConnections() An array of runtime information for all inbound connections for the resource adapter.
int	getInboundConnectionsCount() The number of inbound connections for the resource adapter.
String	getJndiName() Get the Jndi name of the resource adapter.
String	getLinkref() Get the linkref.
String	getSchema() Get the latest schema for RA configuration.
String	getSchema(String version) Get the schema for RA configuration based on the version that is provided.
String	getSpecVersion() Get the spec version.
String	getState() Get the state of the resource adapter.
int	getSuspendedState() Gets the suspended state information of the resource adapter.
String	getVendorName() Get the vendor name.
String	getVersion() Get the version.
String	getVersionId() Get the version Id.
boolean	isActiveVersion() Return true if this version is the active version.
boolean	isVersioned() Check if the resource adapter is versioned.
void	resume(int type) Resumes the specified type of activity for this resource adapter
void	resume(int type, Properties props) Resumes the specified type of activity for this resource adapter
void	resumeAll() Resumes all activities of this resource adapter.
void	suspend(int type) Suspend a particular type of activity for this resource adapter
void	suspend(int type, Properties props) Suspends the specified type of activity for this resource adapter
void	suspendAll() Resumes all activities of this resource adapter.

Methods inherited from interface weblogic.management.runtime.ComponentRuntimeMBean

getDeploymentState, getModuleId, getWorkManagerRuntimes

Methods inherited from interface weblogic.management.WebLogicMBean

getMBeanInfo, getName, 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

Field Detail

ACTIVATED

public static final String ACTIVATED

Resource adapter state definition

INITIALIZED

public static final String INITIALIZED

Resource adapter state definition

NEW

public static final String NEW

Resource adapter state definition

PREPARED

public static final String PREPARED

Resource adapter state definition

SUSPENDED

public static final String SUSPENDED

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

Method Detail

getActiveVersionId

public String getActiveVersionId()

Get the active version Id.

Returns:

String

getAppDeploymentMBean

public weblogic.management.configuration.AppDeploymentMBean getAppDeploymentMBean()

Gets the AppDeploymentMBean for the Connector Component

getComponentName

public String getComponentName()

Get the name of the connector component.

Returns:

String

getConfiguration

public 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

public 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

getConfigurationVersion

public String getConfigurationVersion()

Return the latest configuration version.<.p>

Returns:

String

getConfiguredProperties

public Properties getConfiguredProperties()

Gets a subset of the resource adapter descriptor information.

getConnectionPool

public 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

getConnectionPoolCount

public int getConnectionPoolCount()

The number of connection pools.

Returns:

Count of the number of connection pools.

getConnectionPools

public 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

getConnectorComponentMBean

public ConnectorComponentMBean getConnectorComponentMBean()

Gets the ConnectorComponentMBean for the Connector Component.

getConnectorServiceRuntime

public ConnectorServiceRuntimeMBean getConnectorServiceRuntime()

Return the connector service runtime.

Returns:

ConnectorServiceRuntimeMBean

getDescription

public String getDescription()

Get the Description for the resource adapter.

Returns:

String

getDescriptions

public String[] getDescriptions()

Get the Descriptions for the resource adapter.

Returns:

String[]

getEISResourceId

public String getEISResourceId()

Returns the EISResourceId for the component.

Returns:

The eisResourceId attribute for the resource adapter.

getEISType

public String getEISType()

Get the EIS type.

Returns:

String

getInboundConnection

public 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.

getInboundConnections

public ConnectorInboundRuntimeMBean[] getInboundConnections()

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

Returns:

An array of ConnectorInboundRuntimeMBean objects.

getInboundConnectionsCount

public int getInboundConnectionsCount()

The number of inbound connections for the resource adapter.

Returns:

Count of the number of inbound connections.

getJndiName

public String getJndiName()

Get the Jndi name of the resource adapter.

Returns:

String

getLinkref

public String getLinkref()

Get the linkref.

Returns:

String

getSchema

public String getSchema()

Get the latest schema for RA configuration.

Returns:

String

getSchema

public 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

getSpecVersion

public String getSpecVersion()

Get the spec version.

Returns:

String

getState

public String getState()

Get the state of the resource adapter.

Returns:

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

getSuspendedState

public 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:

weblogic.connector.extensions.Suspendable

getVendorName

public String getVendorName()

Get the vendor name.

Returns:

String

getVersion

public String getVersion()

Get the version.

Returns:

String

getVersionId

public String getVersionId()

Get the version Id.

Returns:

String

isActiveVersion

public boolean isActiveVersion()

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

Returns:

boolean

isVersioned

public boolean isVersioned()

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

Returns:

boolean

resume

public void resume(int type)
            throws weblogic.utils.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:

weblogic.utils.ErrorCollectionException - if something goes wrong

resume

public void resume(int type,
                   Properties props)
            throws weblogic.utils.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:

weblogic.utils.ErrorCollectionException - if something goes wrong

resumeAll

public void resumeAll()
               throws weblogic.utils.ErrorCollectionException

Resumes all activities of this resource adapter.

Throws:

weblogic.utils.ErrorCollectionException - if something goes wrong

suspend

public void suspend(int type)
             throws weblogic.utils.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:

weblogic.utils.ErrorCollectionException - if something goes wrong

suspend

public void suspend(int type,
                    Properties props)
             throws weblogic.utils.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:

weblogic.utils.ErrorCollectionException - if something goes wrong

suspendAll

public void suspendAll()
                throws weblogic.utils.ErrorCollectionException

Resumes all activities of this resource adapter.

Throws:

weblogic.utils.ErrorCollectionException - if something goes wrong