Oracle Fusion Middleware
Java API Reference for Oracle WebLogic Server
12c (12.1.3)

Part Number E41849-02

weblogic.management.runtime
Interface ConnectorServiceRuntimeMBean

All Superinterfaces:
DynamicMBean, MBeanRegistration, NotificationBroadcaster, RuntimeMBean, WebLogicMBean

public interface ConnectorServiceRuntimeMBean
extends RuntimeMBean

This interface defines the runtime information that can be accessed at a connector service level. Runtime information can be accessed at a per resource adapter level or at an overall level.

Access limited to the following security roles:
Operator

Method Summary
 int getActiveRACount()
          Returns the number of resource adapters that are active.
 ConnectorComponentRuntimeMBean[] getActiveRAs()
          Returns an array of runtime information for all deployed and active resource adapters.
 ConnectorConnectionPoolRuntimeMBean getConnectionPool(String key)
          Deprecated.  
 int getConnectionPoolCurrentCount()
          Deprecated.  
 ConnectorConnectionPoolRuntimeMBean[] getConnectionPools()
          Deprecated.  
 int getConnectionPoolsTotalCount()
          Deprecated.  
 ConnectorComponentRuntimeMBean[] getInactiveRAs()
          Returns an array of runtime information for all deployed and inactive resource adapters.
 ConnectorInboundRuntimeMBean[] getInboundConnections(String messageListenerType)
          Returns runtime information for the specified inbound connection.
 ConnectorComponentRuntimeMBean getRA(String key)
          Returns the runtime information of the resource adapter specified by the given JNDI name.
 int getRACount()
          Returns the number of resource adapters that have been deployed in the server.
 ConnectorComponentRuntimeMBean[] getRAs()
          Returns an array of runtime information for all deployed resource adapters.
 void resume(int type)
          Resumes the specified type of activity for all RAs.
 void resume(int type, Properties props)
          Resumes the specified type of activity for all RAs
 void resumeAll()
          Resumes all activities of all resource adapters.
 void resumeAll(Properties props)
          Resumes all activities of all resource adapters.
 void suspend(int type)
          Suspends the specified type of activity for all RAs.
 void suspend(int type, Properties props)
          Suspends the specified type of activity for all RAs
 void suspendAll()
          Suspends all activities of all resource adapters.
 void suspendAll(Properties props)
          Suspends all activities of all resource adapters.
 
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
 

Method Detail

getActiveRACount

int getActiveRACount()

Returns the number of resource adapters that are active.

Returns:
Resource adapter current count.

getRACount

int getRACount()

Returns the number of resource adapters that have been deployed in the server. This count includes active RAs and Non-active RAs ( in the case of versioned RAs that are being replaced by a new version )

Returns:
Resource adapter total count.

getRAs

ConnectorComponentRuntimeMBean[] getRAs()

Returns an array of runtime information for all deployed resource adapters.

Returns:
An array of ConnectorComponentRuntimeMBean objects.

getActiveRAs

ConnectorComponentRuntimeMBean[] getActiveRAs()

Returns an array of runtime information for all deployed and active resource adapters.

Returns:
An array of ConnectorComponentRuntimeMBean objects.

getInactiveRAs

ConnectorComponentRuntimeMBean[] getInactiveRAs()

Returns an array of runtime information for all deployed and inactive resource adapters.

Returns:
An array of ConnectorComponentRuntimeMBean objects.

getRA

ConnectorComponentRuntimeMBean getRA(String key)

Returns the runtime information of the resource adapter specified by the given JNDI name. A null is returned if the resource adapter cannot be found. This function returns the active RA if multiple versions of the resource adapters has been deployed

Parameters:
key - The JNDI name of the resource adapter.
Returns:
A ConnectorComponentRuntimeMBean object representing the resource adapter.

getConnectionPoolCurrentCount

int getConnectionPoolCurrentCount()
Deprecated. 

Returns the number of connection pools in all active RAs.

Returns:
The connectionPoolCurrentCount value

getConnectionPoolsTotalCount

int getConnectionPoolsTotalCount()
Deprecated. 

Returns the number of resource adapter connection pools that have been created since server startup. This includes re-deployments.

Returns the total number of deployed connection pools instantiated since server startup.

Returns:
Total number of connection pools.

getConnectionPools

ConnectorConnectionPoolRuntimeMBean[] getConnectionPools()
Deprecated. 

Returns connection pool runtimes for all active resource adapters.

Returns:
The connectionPools value

getConnectionPool

ConnectorConnectionPoolRuntimeMBean getConnectionPool(String key)
Deprecated. 

Returns a ConnectorConnectionPoolRuntimeMBean that represents the statistics for a Deployed Connection Pool (a deployed connection pool is equivalent to a deployed RAR).

Parameters:
key - by which to find the connection pool. this could be the jndi name or the resource-link.
Returns:
The connectionPool's value

getInboundConnections

ConnectorInboundRuntimeMBean[] getInboundConnections(String messageListenerType)

Returns runtime information for the specified inbound connection. A null is returned if the inbound connection is not found.

Parameters:
messageListenerType - Message listener type.
Returns:
ConnectorInboundRuntimeMBean[].

suspendAll

void suspendAll(Properties props)
                throws ErrorCollectionException

Suspends all activities of all resource adapters.

Parameters:
props - Properties to be passed to the resource adapters or null
Throws:
ErrorCollectionException - A collection of exceptions if something goes wrong

suspend

void suspend(int type,
             Properties props)
             throws ErrorCollectionException

Suspends the specified type of activity for all RAs

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 - A collection of exceptions if something goes wrong

resumeAll

void resumeAll(Properties props)
               throws ErrorCollectionException

Resumes all activities of all resource adapters.

Parameters:
props - Properties to be passed to the resource adapters or null
Throws:
ErrorCollectionException - A collection of exceptions if something goes wrong

resume

void resume(int type,
            Properties props)
            throws ErrorCollectionException

Resumes the specified type of activity for all RAs

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 - A collection of exceptions if something goes wrong

suspendAll

void suspendAll()
                throws ErrorCollectionException

Suspends all activities of all resource adapters.

Throws:
ErrorCollectionException - A collection of exceptions if something goes wrong

suspend

void suspend(int type)
             throws ErrorCollectionException

Suspends the specified type of activity for all RAs.

Parameters:
type - int The type of activity(ies), @see weblogic.connector.extensions.Suspendable
Throws:
ErrorCollectionException - A collection of exceptions if something goes wrong

resumeAll

void resumeAll()
               throws ErrorCollectionException

Resumes all activities of all resource adapters.

Throws:
ErrorCollectionException - A collection of exceptions if something goes wrong

resume

void resume(int type)
            throws ErrorCollectionException

Resumes the specified type of activity for all RAs.

Parameters:
type - int The type of activity(ies), @see weblogic.connector.extensions.Suspendable
Throws:
ErrorCollectionException - A collection of exceptions if something goes wrong

Copyright 1996, 2014, 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.3)

Part Number E41849-02