|
BEA Systems, Inc. | |||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
.
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://edocs.bea.com.
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 |
public static final String ACTIVATED
public static final String INITIALIZED
public static final String NEW
public static final String PREPARED
public static final String SUSPENDED
Method Detail |
public String getActiveVersionId()
Get the active version Id.
public weblogic.management.configuration.AppDeploymentMBean getAppDeploymentMBean()
Gets the AppDeploymentMBean for the Connector Component
public String getComponentName()
Get the name of the connector component.
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"
public String getConfiguration(String version)
Return the xml string representing the RA configuration. The xml corresponding to the version specified is returned.
version
- String
public String getConfigurationVersion()
Return the latest configuration version.<.p>
public Properties getConfiguredProperties()
Gets a subset of the resource adapter descriptor information.
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.
key
- JNDI name or resource-link name of the connection pool.
ConnectorConnectionPoolRuntimeMBean
public int getConnectionPoolCount()
The number of connection pools.
public ConnectorConnectionPoolRuntimeMBean[] getConnectionPools()
An array of ConnectorConnectionPoolRuntimeMBeans
,
each of which represents the runtime data for a connection pool in
the resource adapter.
ConnectorConnectionPoolRuntimeMBean
public ConnectorComponentMBean getConnectorComponentMBean()
Gets the ConnectorComponentMBean for the Connector Component.
public ConnectorServiceRuntimeMBean getConnectorServiceRuntime()
Return the connector service runtime.
public String getDescription()
Get the Description for the resource adapter.
public String[] getDescriptions()
Get the Descriptions for the resource adapter.
public String getEISResourceId()
Returns the EISResourceId for the component.
public String getEISType()
Get the EIS type.
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.
messageListenerType
- Message listener type.
public ConnectorInboundRuntimeMBean[] getInboundConnections()
An array of runtime information for all inbound connections for the resource adapter.
public int getInboundConnectionsCount()
The number of inbound connections for the resource adapter.
public String getJndiName()
Get the Jndi name of the resource adapter.
public String getLinkref()
Get the linkref.
public String getSchema()
Get the latest schema for RA configuration.
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"
version
- String
public String getSpecVersion()
Get the spec version.
public String getState()
Get the state of the resource adapter.
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
weblogic.connector.extensions.Suspendable
public String getVendorName()
Get the vendor name.
public String getVersion()
Get the version.
public String getVersionId()
Get the version Id.
public boolean isActiveVersion()
Return true if this version is the active version. Returns true if this resource adapter is not versioned.
public boolean isVersioned()
Check if the resource adapter is versioned. Returns true if it is.
public void resume(int type) throws weblogic.utils.ErrorCollectionException
Resumes the specified type of activity for this resource adapter
type
- int The type of activity(ies), @see weblogic.connector.extensions.Suspendable
weblogic.utils.ErrorCollectionException
- if something goes wrongpublic void resume(int type, Properties props) throws weblogic.utils.ErrorCollectionException
Resumes the specified type of activity for this resource adapter
type
- int The type of activity(ies), @see weblogic.connector.extensions.Suspendableprops
- Properties to pass on to the RA or null
weblogic.utils.ErrorCollectionException
- if something goes wrongpublic void resumeAll() throws weblogic.utils.ErrorCollectionException
Resumes all activities of this resource adapter.
weblogic.utils.ErrorCollectionException
- if something goes wrongpublic void suspend(int type) throws weblogic.utils.ErrorCollectionException
Suspend a particular type of activity for this resource adapter
type
- int The type of activity(ies), @see weblogic.connector.extensions.Suspendable
weblogic.utils.ErrorCollectionException
- if something goes wrongpublic void suspend(int type, Properties props) throws weblogic.utils.ErrorCollectionException
Suspends the specified type of activity for this resource adapter
type
- int The type of activity(ies), @see weblogic.connector.extensions.Suspendableprops
- Properties to pass on to the RA or null
weblogic.utils.ErrorCollectionException
- if something goes wrongpublic void suspendAll() throws weblogic.utils.ErrorCollectionException
Resumes all activities of this resource adapter.
weblogic.utils.ErrorCollectionException
- if something goes wrong
|
Documentation is available at http://e-docs.bea.com/wls/docs90 Copyright 2005 BEA Systems Inc. |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |