|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CoreMonitoringAdmin
Used to access the monitorable components of the MetaMatrix system.
As a core interface, this administration is common to both the MetaMatrix server and MM Query.
See the particular admin object in question for an example of allowed identifier patterns.
Method Summary | |
---|---|
java.util.Collection |
getCaches(java.lang.String identifier)
Get the Caches that correspond to the specified identifer pattern |
java.util.Collection |
getConnectorBindings(java.lang.String connectorBindingIdentifier)
Get the Connector Bindings that correspond to the specifed identifer pattern. |
java.util.Collection |
getConnectorBindingsInVDB(java.lang.String identifier)
Get all the Connector Bindings for the given VDB identifier pattern |
java.util.Collection |
getConnectorTypes(java.lang.String connectorTypeIdentifier)
Get the Connector Types that correspond to the specified identifer pattern. |
java.util.Collection |
getExtensionModules(java.lang.String extensionModuleIdentifier)
Get the Extension Modules that correspond to the specified identifer pattern |
java.util.Collection |
getPropertyDefinitions(java.lang.String identifier,
java.lang.String className)
Get all of the available Configuration Properties for the specified AdminObject, and details about them. |
java.util.Collection |
getQueueWorkerPools(java.lang.String identifier)
Get the Queue Worker Pools that correspond to the specified identifer pattern. |
java.util.Collection |
getRequests(java.lang.String identifier)
Get the Requests that correspond to the specified identifer pattern |
java.util.Collection |
getSessions(java.lang.String identifier)
Get the Sessions that correspond to the specified identifer pattern |
java.util.Collection |
getSourceRequests(java.lang.String identifier)
Get the Source Request that correspond to the specified identifer pattern |
SystemObject |
getSystem()
Retrieve the single System object. |
java.util.Collection |
getVDBs(java.lang.String vdbIdentifier)
Get the VDBs that correspond to the specifed identifer pattern. |
Method Detail |
---|
SystemObject getSystem() throws AdminException
SystemObject
object, for interacting with system-wide configuration
AdminException
- if there's a system error.java.util.Collection getConnectorTypes(java.lang.String connectorTypeIdentifier) throws AdminException
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
ConnectorType
AdminException
- if there's a system error.java.util.Collection getVDBs(java.lang.String vdbIdentifier) throws AdminException
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
VDB
s. There could be multiple VDBs with the
same name in the Collection but they will differ by VDB version.
AdminException
- if there's a system error.java.util.Collection getConnectorBindings(java.lang.String connectorBindingIdentifier) throws AdminException
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
ConnectorBinding
AdminException
- if there's a system error.java.util.Collection getConnectorBindingsInVDB(java.lang.String identifier) throws AdminException
identifier
- - the unique identifier for a VDB
"*"
- for all Connector Bindings in the system
"name or name*"
- for all the bindings in the VDBs that begin with given name
"name<AdminObject.DELIMITER_CHAR
>version"
- for all the bindings in a given single VDB
ConnectorBinding
AdminException
- if there's a system error.java.util.Collection getExtensionModules(java.lang.String extensionModuleIdentifier) throws AdminException
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
ExtensionModule
AdminException
- if there's a system error.java.util.Collection getQueueWorkerPools(java.lang.String identifier) throws AdminException
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
QueueWorkerPool
AdminException
- if there's a system error.java.util.Collection getCaches(java.lang.String identifier) throws AdminException
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
Cache
AdminException
- if there's a system error.java.util.Collection getSessions(java.lang.String identifier) throws AdminException
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
Session
AdminException
- if there's a system error.java.util.Collection getRequests(java.lang.String identifier) throws AdminException
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 perticular session etc.
"number<AdminObject.DELIMITER_CHAR
>number"
- for a single request in the system
Request
AdminException
- if there's a system error.java.util.Collection getSourceRequests(java.lang.String identifier) throws AdminException
identifier
- An Identifier for Request
"*"
- for all current in process requests of the system
"number* or number<AdminObject.DELIMITER_CHAR
>* or number.number.*"
- for all the sessions
that begin with given number, or all the requests for perticular session etc.
"number<AdminObject.DELIMITER_CHAR
>number<AdminObject.DELIMITER_CHAR
>number"
- for a single source request in the system
SourceRequest
AdminException
- if there's a system error.java.util.Collection getPropertyDefinitions(java.lang.String identifier, java.lang.String className) throws AdminException
identifier
- The unique identifier for for an AdminObject
.className
- The class name of the sub-interface of AdminObject
you are setting the property for. These are all the
supported class names. SystemObject
, Host
, ProcessObject
, ConnectorBinding
,
ConnectorType
,DQP
, Resource
Note that in Embedded mode only supported classes are ConnectorBinding
, ConnectorType
,
SystemObject
AdminException
- if there's a system error.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |