|
Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-02 |
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ConnectorComponentRuntimeMBean
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
.
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. |
AppDeploymentMBean |
getAppDeploymentMBean()
Deprecated. 9.1.0.0 Acquire this by looking up the AppDeploymentMBean with the same name as the parent ApplicationRuntime |
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()
Deprecated. 9.1.0.0 The connector component mbean was already deprecated. |
ConnectorServiceRuntimeMBean |
getConnectorServiceRuntime()
Return the connector service runtime. |
ConnectorWorkManagerRuntimeMBean |
getConnectorWorkManagerRuntime()
Runtime information for adapter's work manager that beyond WebLogic's standard work manager. |
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. |
HealthState |
getHealthState()
The HealthState mbean for the application. |
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. |
WorkManagerRuntimeMBean |
getWorkManagerRuntime()
Runtime information for WebLogic's work manager that serves the adapter. |
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 |
---|
static final String NEW
static final String INITIALIZED
static final String PREPARED
static final String ACTIVATED
static final String SUSPENDED
Method Detail |
---|
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.
ConnectorConnectionPoolRuntimeMBean
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
int getInboundConnectionsCount()
The number of inbound connections for the resource adapter.
ConnectorInboundRuntimeMBean[] getInboundConnections()
An array of runtime information for all inbound connections for the resource adapter.
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.
String getEISResourceId()
Returns the EISResourceId for the component.
void suspendAll() throws ErrorCollectionException
Resumes all activities of this resource adapter.
ErrorCollectionException
- if something goes wrongvoid suspend(int type) throws ErrorCollectionException
Suspend a particular type of activity for this resource adapter
type
- int The type of activity(ies), @see weblogic.connector.extensions.Suspendable
ErrorCollectionException
- if something goes wrongvoid suspend(int type, Properties props) throws 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
ErrorCollectionException
- if something goes wrongvoid resumeAll() throws ErrorCollectionException
Resumes all activities of this resource adapter.
ErrorCollectionException
- if something goes wrongvoid resume(int type) throws ErrorCollectionException
Resumes the specified type of activity for this resource adapter
type
- int The type of activity(ies), @see weblogic.connector.extensions.Suspendable
ErrorCollectionException
- if something goes wrongvoid resume(int type, Properties props) throws 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
ErrorCollectionException
- if something goes wrongProperties getConfiguredProperties()
Gets a subset of the resource adapter descriptor information.
AppDeploymentMBean getAppDeploymentMBean()
Gets the AppDeploymentMBean for the Connector Component
ConnectorComponentMBean getConnectorComponentMBean()
Gets the ConnectorComponentMBean for the Connector Component.
ConnectorServiceRuntimeMBean getConnectorServiceRuntime()
Return the connector service runtime.
String getVersionId()
Get the version Id.
String getActiveVersionId()
Get the active version Id.
boolean isVersioned()
Check if the resource adapter is versioned. Returns true if it is.
boolean isActiveVersion()
Return true if this version is the active version. Returns true if this resource adapter is not versioned.
String getJndiName()
Get the Jndi name of the resource adapter.
String getState()
Get the state of the resource adapter.
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
Suspendable
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. Return null if the version is not found. The current supported version is "1.0"
version
- String
String getConfigurationVersion()
Return the latest configuration version.<.p>
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"
String getConfiguration(String version)
Return the xml string representing the RA configuration. The xml corresponding to the version specified is returned.
version
- String
String getDescription()
Get the Description for the resource adapter.
String[] getDescriptions()
Get the Descriptions for the resource adapter.
String getEISType()
Get the EIS type.
String getSpecVersion()
Get the spec version.
String getVendorName()
Get the vendor name.
String getVersion()
Get the version.
String getLinkref()
Get the linkref.
String getComponentName()
Get the name of the connector component.
WorkManagerRuntimeMBean getWorkManagerRuntime()
Runtime information for WebLogic's work manager that serves the adapter. It provides general runtime information by WebLogic work manager.
WorkManagerRuntimeMBean
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.
ConnectorWorkManagerRuntimeMBean
HealthState getHealthState()
The HealthState mbean for the application.
getHealthState
in interface HealthFeedback
HealthState
|
Copyright 1996, 2013, Oracle and/or its affiliates. All rights reserved. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners. Oracle Fusion Middleware Java API Reference for Oracle WebLogic Server 12c (12.1.2) Part Number E27170-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |