org.teiid.adminapi
Interface MonitoringAdmin

All Known Subinterfaces:
Admin, ServerAdmin, ServerMonitoringAdmin
All Known Implementing Classes:
DQPMonitoringAdminImpl, ServerAdminImpl, ServerMonitoringAdminImpl

@RolesAllowed(value="Admin.ReadOnlyAdmin")
public interface MonitoringAdmin

Used to access the monitorable components of the Teiid system.

See the particular admin object in question for an example of allowed identifier patterns.

Since:
4.3

Method Summary
 java.util.Collection<Cache> getCaches(java.lang.String identifier)
          Get the Caches that correspond to the specified identifier pattern
 java.util.Collection<? extends ConnectionPool> getConnectionPoolStats(java.lang.String identifier)
          Get the Connection Pool Stats that correspond to the specified identifier pattern.
 java.util.Collection<ConnectorBinding> getConnectorBindings(java.lang.String connectorBindingIdentifier)
          Get the Connector Bindings that correspond to the specified identifier pattern.
 java.util.Collection<ConnectorBinding> getConnectorBindingsInVDB(java.lang.String vdbName, java.lang.String vdbVersion)
          Get all the Connector Bindings for the given VDB identifier pattern
 java.util.Collection<PropertyDefinition> getConnectorTypePropertyDefinitions(java.lang.String connectorTypeIdentifier)
          Get all of the available Configuration Properties for the specified AdminObject, and details about them.
 java.util.Collection<ConnectorType> getConnectorTypes(java.lang.String connectorTypeIdentifier)
          Get the Connector Types that correspond to the specified identifier pattern.
 java.util.Collection<ExtensionModule> getExtensionModules(java.lang.String extensionModuleIdentifier)
          Get the Extension Modules that correspond to the specified identifier pattern
 java.util.Collection<ProcessObject> getProcesses(java.lang.String processIdentifier)
          Get the processes that correspond to the specified identifier pattern.
 java.util.Collection<QueueWorkerPool> getQueueWorkerPools(java.lang.String identifier)
          Get the Queue Worker Pools that correspond to the specified identifier pattern.
 java.util.Collection<Request> getRequests(java.lang.String identifier)
          Get the Requests that correspond to the specified identifier pattern
 java.util.Collection<Session> getSessions(java.lang.String identifier)
          Get the Sessions that correspond to the specified identifier pattern
 java.util.Collection<Request> getSourceRequests(java.lang.String identifier)
          Get the Source Request that correspond to the specified identifier pattern
 java.util.Collection<Transaction> getTransactions()
          Get all transaction matching the identifier.
 java.util.Collection<VDB> getVDBs(java.lang.String vdbIdentifier)
          Get the VDBs that correspond to the specified identifier pattern.
 

Method Detail

getConnectorTypes

java.util.Collection<ConnectorType> getConnectorTypes(java.lang.String connectorTypeIdentifier)
                                                      throws AdminException
Get the Connector Types that correspond to the specified identifier pattern.

Parameters:
connectorTypeIdentifier - the unique identifier for for a ConnectorType
  • "*" - for all connector types in the system
  • "name*" - for all the connector types that begin with given name
  • "name" - for the single connector type identified by name
Returns:
Collection of ConnectorType
Throws:
AdminException - if there's a system error.
Since:
4.3

getVDBs

@RolesAllowed(value="Anonymous")
java.util.Collection<VDB> getVDBs(java.lang.String vdbIdentifier)
                                  throws AdminException
Get the VDBs that correspond to the specified identifier pattern.

Parameters:
vdbIdentifier - the unique identifier for for a VDB in the system
  • "*" - for all VDBs in the system
  • "name" or "name*" - for all the VDBs that begin with given name
  • "name<AdminObject.DELIMITER_CHAR>version" - for single VDB
Returns:
Collection of VDBs. There could be multiple VDBs with the same name in the Collection but they will differ by VDB version.
Throws:
AdminException - if there's a system error.
Since:
4.3

getConnectorBindings

java.util.Collection<ConnectorBinding> getConnectorBindings(java.lang.String connectorBindingIdentifier)
                                                            throws AdminException
Get the Connector Bindings that correspond to the specified identifier pattern.

Parameters:
connectorBindingIdentifier - the unique identifier pattern of ConnectorBinding
  • "*" - for all connector bindings in the system
  • "name*" - for all connector bindings that begin with given name
  • "name" - for single connector binding by the given name
Returns:
Collection of ConnectorBinding
Throws:
AdminException - if there's a system error.
Since:
4.3

getConnectorBindingsInVDB

java.util.Collection<ConnectorBinding> getConnectorBindingsInVDB(java.lang.String vdbName,
                                                                 java.lang.String vdbVersion)
                                                                 throws AdminException
Get all the Connector Bindings for the given VDB identifier pattern

Parameters:
vdbName - - Name of the VDB
vdbVersion - - version of the VDB
Returns:
Collection of ConnectorBinding
Throws:
AdminException - if there's a system error.
Since:
4.3

getExtensionModules

java.util.Collection<ExtensionModule> getExtensionModules(java.lang.String extensionModuleIdentifier)
                                                          throws AdminException
Get the Extension Modules that correspond to the specified identifier pattern

Parameters:
extensionModuleIdentifier - - the unique identifier for ExtensionModule
  • "*" - for all extension modules in the system
  • "name*" - for all the extension modules in that begin with given name
  • "name" - for a single extension module identified by given name
Returns:
Collection of ExtensionModule
Throws:
AdminException - if there's a system error.
Since:
4.3

getQueueWorkerPools

java.util.Collection<QueueWorkerPool> getQueueWorkerPools(java.lang.String identifier)
                                                          throws AdminException
Get the Queue Worker Pools that correspond to the specified identifier pattern.

Parameters:
identifier - - an identfier for the queues QueueWorkerPool
  • "*" - for all Queue workers in the system
  • "name*" - for all the Queue workers in that begin with given name
  • "name" - for a single queue in the system
for example, In MM Query - "dqp" will return the Stats for MM Query Worker Pool. Also any Connector Binding name will return the stats for that connector binding.
Returns:
Collection of QueueWorkerPool
Throws:
AdminException - if there's a system error.
Since:
4.3

getConnectionPoolStats

java.util.Collection<? extends ConnectionPool> getConnectionPoolStats(java.lang.String identifier)
                                                                      throws AdminException
Get the Connection Pool Stats that correspond to the specified identifier pattern. If the ConnectionPool represents an XA connection, there will be 2 ConnectionPools.

Parameters:
identifier - - an identfier that corresponds to the ConnectorBinding that is running in a process ConnectionPool
  • "*" - for all Connection Pools in the system
  • "name*" - for all the Connection Pools that begin with given name
  • "name" - for a single Connection Pool in the system
Returns:
Collection of ConnectionPool
Throws:
AdminException - if there's a system error.
Since:
6.1

getCaches

java.util.Collection<Cache> getCaches(java.lang.String identifier)
                                      throws AdminException
Get the Caches that correspond to the specified identifier pattern

Parameters:
identifier - - an identifier for the cache in Cache
  • "*" - for all different caches in the system
  • "name*" - for all the caches that begin with given name
  • "name" - for a single cache in the system
Returns:
Collection of Cache
Throws:
AdminException - if there's a system error.
Since:
4.3

getSessions

java.util.Collection<Session> getSessions(java.lang.String identifier)
                                          throws AdminException
Get the Sessions that correspond to the specified identifier pattern

Parameters:
identifier - - an unique identifier for Session
  • "*" - for all current sessions of the system
  • "number*" - for all the sessions that begin with given number
  • "number" - for a single current session in the system
Returns:
Collection of Session
Throws:
AdminException - if there's a system error.
Since:
4.3

getRequests

java.util.Collection<Request> getRequests(java.lang.String identifier)
                                          throws AdminException
Get the Requests that correspond to the specified identifier pattern

Parameters:
identifier - - An Identifier for Request
  • "*" - for all current in process requests of the system
  • "number* or number<AdminObject.DELIMITER_CHAR>*" - for all the sessions that begin with given number, or all the requests for particular session etc.
  • "number<AdminObject.DELIMITER_CHAR>number" - for a single request in the system
Returns:
Collection of Request
Throws:
AdminException - if there's a system error.
Since:
4.3

getSourceRequests

java.util.Collection<Request> getSourceRequests(java.lang.String identifier)
                                                throws AdminException
Get the Source Request that correspond to the specified identifier pattern

Parameters:
identifier - An Identifier for Request
Returns:
Collection of Request
Throws:
AdminException - if there's a system error.
Since:
4.3

getConnectorTypePropertyDefinitions

java.util.Collection<PropertyDefinition> getConnectorTypePropertyDefinitions(java.lang.String connectorTypeIdentifier)
                                                                             throws AdminException
Get all of the available Configuration Properties for the specified AdminObject, and details about them.

Parameters:
connectorTypeIdentifier -
Returns:
Throws:
AdminException

getTransactions

java.util.Collection<Transaction> getTransactions()
                                                  throws AdminException
Get all transaction matching the identifier.

Returns:
Throws:
AdminException

getProcesses

@RolesAllowed(value="Anonymous")
java.util.Collection<ProcessObject> getProcesses(java.lang.String processIdentifier)
                                                 throws AdminException
Get the processes that correspond to the specified identifier pattern.

Parameters:
processIdentifier - the unique identifier for for a ProcessObject in the system or "WILDCARD" if all Processes are desired.
Returns:
Collection of ProcessObject
Throws:
AdminException - if there's a system error.
Since:
4.3


Copyright © 2009. All Rights Reserved.