com.metamatrix.admin.server
Class ServerMonitoringAdminImpl

java.lang.Object
  com.metamatrix.admin.server.AbstractAdminImpl
      com.metamatrix.admin.server.ServerMonitoringAdminImpl

All Implemented Interfaces:

CoreMonitoringAdmin, ServerMonitoringAdmin

public class ServerMonitoringAdminImpl
extends AbstractAdminImpl
implements ServerMonitoringAdmin

Since:

4.3

Field Summary

Fields inherited from class com.metamatrix.admin.server.AbstractAdminImpl

parent, registry

Constructor Summary

ServerMonitoringAdminImpl(ServerAdminImpl parent, ClusteredRegistryState registry)

Method Summary

byte[]	exportLogs() Export the server logs to a byte[].
java.util.Collection	getCaches(java.lang.String identifier) Get monitoring information about caches.
java.util.Collection	getConnectorBindings(java.lang.String identifier) Get monitoring information about connector bindings.
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 identifier) Get monitoring information about connector types.
java.util.Collection	getDQPs(java.lang.String identifier) Get monitoring information about DQPs (Distributed Query Processors).
java.util.Collection	getExtensionModules(java.lang.String identifier) Get monitoring information about extension modules.
java.util.Collection	getHosts(java.lang.String identifier) Get monitoring information about hosts.
java.util.Collection	getProcesses(java.lang.String identifier) Get monitoring information about processes.
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 monitoring information about worker queues for DQPs or connector bindings.
java.util.Collection	getRequests(java.lang.String identifier) Get monitoring information about requests.
java.util.Collection	getResources(java.lang.String identifier) Get monitoring information about resources.
java.util.Collection	getSessions(java.lang.String identifier) Get monitoring information about sessions.
java.util.Collection	getSourceRequests(java.lang.String identifier) Get monitoring information about source requests.
SystemObject	getSystem() Get monitoring information about the sytem at large.
java.util.Collection	getVDBs(java.lang.String identifier) Get monitoring information about VDBs (Virtual Databases).
protected static java.lang.String	trimString(java.lang.String string)

Methods inherited from class com.metamatrix.admin.server.AbstractAdminImpl

convertPropertyDefinitions, convertPropertyDefinitions, convertPropertyDefinitions, convertToAdminVDB, getAdminObjects, getAuthorizationServiceProxy, getConfigurationModel, getConfigurationServiceProxy, getConnectorBindingNameFromUUID, getConnectorBindingNamesFromUUIDs, getConnectorBindingNamesFromUUIDs, getConnectorBindingNamesMapFromUUIDs, getExtensionSourceManager, getMembershipServiceProxy, getName, getParent, getQueryServiceProxy, getRuntimeStateAdminAPIHelper, getSessionID, getSessionServiceProxy, getUserName, getVDBs, identifierMatches, identifierMatches, logDetail, shutDownConnectorBinding, throwProcessingException, validateSession

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServerMonitoringAdminImpl

public ServerMonitoringAdminImpl(ServerAdminImpl parent,
                                 ClusteredRegistryState registry)

Method Detail

getCaches

public java.util.Collection getCaches(java.lang.String identifier)
                               throws AdminException

Get monitoring information about caches.

Specified by:

getCaches in interface CoreMonitoringAdmin

Parameters:

identifier - Identifier of the cache to get information for. For example, "CodeTable".

If identifier is "*", this method returns information for all caches in the system.

Returns:

a Collection of com.metamatrix.admin.api.Cache

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreMonitoringAdmin.getCaches(java.lang.String)

getConnectorBindings

public java.util.Collection getConnectorBindings(java.lang.String identifier)
                                          throws AdminException

Get monitoring information about connector bindings.

Specified by:

getConnectorBindings in interface CoreMonitoringAdmin

Parameters:

identifier - Fully-qualified identifier of a host, process, or connector binding to get information for. For example, "hostname", or "hostname.processname", or " "hostname.processname.bindingname".

If identifier is "*", this method returns information about all connector bindings in the system.

Returns:

a Collection of com.metamatrix.admin.api.ConnectorBinding

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreMonitoringAdmin.getConnectorBindings(java.lang.String)

getConnectorBindingsInVDB

public java.util.Collection getConnectorBindingsInVDB(java.lang.String identifier)
                                               throws AdminException

Description copied from interface: CoreMonitoringAdmin

Get all the Connector Bindings for the given VDB identifier pattern

Specified by:

getConnectorBindingsInVDB in interface CoreMonitoringAdmin

Parameters:

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

Returns:

Collection of ConnectorBinding

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreMonitoringAdmin.getConnectorBindingsInVDB(java.lang.String)

getConnectorTypes

public java.util.Collection getConnectorTypes(java.lang.String identifier)
                                       throws AdminException

Get monitoring information about connector types.

Specified by:

getConnectorTypes in interface CoreMonitoringAdmin

Parameters:

identifier - Identifier of a connector type to get information for. For example, "JDBC Connector".

If identifier is "*", this method returns information about all connector types in the system.

Returns:

a Collection of com.metamatrix.admin.api.ConnectorType

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreMonitoringAdmin.getConnectorTypes(java.lang.String)

getDQPs

public java.util.Collection getDQPs(java.lang.String identifier)
                             throws AdminException

Get monitoring information about DQPs (Distributed Query Processors).

Specified by:

getDQPs in interface ServerMonitoringAdmin

Parameters:

identifier - Fully-qualified identifier of a host or process to get information for. For example, "hostname", or "hostname.processname".

If identifier is "*", this method returns information about all DQPs in the system.

Returns:

a Collection of com.metamatrix.admin.api.DQP

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerMonitoringAdmin.getDQPs(java.lang.String)

getExtensionModules

public java.util.Collection getExtensionModules(java.lang.String identifier)
                                         throws AdminException

Get monitoring information about extension modules.

Specified by:

getExtensionModules in interface CoreMonitoringAdmin

Parameters:

identifier - Identifier of an extension module to get information for.

If identifier is "*", this method returns information about all extension modules in the system. Note that this methods returns the binary contents of each extension module, so you should avoid calling this method with identifier "*" if possible.

Returns:

a Collection of com.metamatrix.admin.api.ExtensionModule

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreMonitoringAdmin.getExtensionModules(java.lang.String)

getHosts

public java.util.Collection getHosts(java.lang.String identifier)
                              throws AdminException

Get monitoring information about hosts.

Specified by:

getHosts in interface ServerMonitoringAdmin

Parameters:

identifier - Identifier of a host to get information for. For example "hostname".

If identifier is "*", this method returns information about all hosts in the system.

Returns:

a Collection of com.metamatrix.admin.api.Host

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerMonitoringAdmin.getHosts(java.lang.String)

getProcesses

public java.util.Collection getProcesses(java.lang.String identifier)
                                  throws AdminException

Get monitoring information about processes.

Specified by:

getProcesses in interface ServerMonitoringAdmin

Parameters:

identifier - Identifier of a host or process to get information for. For example "hostname" or "hostname.processname".

If identifier is "*", this method returns information about all processes in the system.

Returns:

a Collection of com.metamatrix.admin.api.Process

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerMonitoringAdmin.getProcesses(java.lang.String)

getQueueWorkerPools

public java.util.Collection getQueueWorkerPools(java.lang.String identifier)
                                         throws AdminException

Get monitoring information about worker queues for DQPs or connector bindings.

Specified by:

getQueueWorkerPools in interface CoreMonitoringAdmin

Parameters:

identifier - Identifier of a host, process, DQP, connector binding, or worker queue to get information for. For example "hostname", or "hostname.processname", or "hostname.processname.dqpname", or "hostname.processname.bindingname", or "hostname.processname.dqpname.workerqueuename", or "hostname.processname.bindingname.workerqueuename".

NOTE: to get information about the "Socket Worker" queue associated with a process, use getProcess().

If identifier is "*", this method returns information about all worker queues in the system.

Returns:

a Collection of com.metamatrix.admin.api.QueueWorkerPool

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreMonitoringAdmin.getQueueWorkerPools(java.lang.String)

getRequests

public java.util.Collection getRequests(java.lang.String identifier)
                                 throws AdminException

Get monitoring information about requests.

Specified by:

getRequests in interface CoreMonitoringAdmin

Parameters:

identifier - Identifier of a session or request to get information for. For example "sessionID" or "sessionID.requestID".

If identifier is "*", this method returns information about all requests in the system.

Returns:

a Collection of com.metamatrix.admin.api.Request

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreMonitoringAdmin.getRequests(java.lang.String)

getResources

public java.util.Collection getResources(java.lang.String identifier)
                                  throws AdminException

Get monitoring information about resources.

Specified by:

getResources in interface ServerMonitoringAdmin

Parameters:

identifier - Identifier of a resource to get information for. For example "resourceName".

If identifier is "*", this method returns information about all resources in the system.

Returns:

a Collection of com.metamatrix.admin.api.Resource

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

ServerMonitoringAdmin.getResources(java.lang.String)

getSessions

public java.util.Collection getSessions(java.lang.String identifier)
                                 throws AdminException

Get monitoring information about sessions.

Specified by:

getSessions in interface CoreMonitoringAdmin

Parameters:

identifier - Identifier of a session to get information for. For example "sessionID".

If identifier is "*", this method returns information about all sessions in the system.

Returns:

a Collection of com.metamatrix.admin.api.Session

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreMonitoringAdmin.getSessions(java.lang.String)

getSourceRequests

public java.util.Collection getSourceRequests(java.lang.String identifier)
                                       throws AdminException

Get monitoring information about source requests.

Specified by:

getSourceRequests in interface CoreMonitoringAdmin

Parameters:

identifier - Identifier of a session or source request to get information for. For example "sessionID" or "sessionID.requestID".

If identifier is "*", this method returns information about all source requests in the system.

Returns:

a Collection of com.metamatrix.admin.api.SourceRequest

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreMonitoringAdmin.getSourceRequests(java.lang.String)

getSystem

public SystemObject getSystem()
                       throws AdminException

Get monitoring information about the sytem at large.

Specified by:

getSystem in interface CoreMonitoringAdmin

Returns:

object containing information about the system.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreMonitoringAdmin.getSystem()

getVDBs

public java.util.Collection getVDBs(java.lang.String identifier)
                             throws AdminException

Get monitoring information about VDBs (Virtual Databases).

Specified by:

getVDBs in interface CoreMonitoringAdmin

Parameters:

identifier - Identifier of a VDB to get information for. For example "vdbname".

If identifier is "*", this method returns information about all VDBs in the system.

Returns:

a Collection of com.metamatrix.admin.api.VDB

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreMonitoringAdmin.getVDBs(java.lang.String)

getPropertyDefinitions

public java.util.Collection getPropertyDefinitions(java.lang.String identifier,
                                                   java.lang.String className)
                                            throws AdminException

Description copied from interface: CoreMonitoringAdmin

Get all of the available Configuration Properties for the specified AdminObject, and details about them.

Specified by:

getPropertyDefinitions in interface CoreMonitoringAdmin

Parameters:

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

Returns:

Collection of PropertyDefinition objects.

Throws:

AdminException - if there's a system error.

Since:

4.3

See Also:

CoreMonitoringAdmin.getPropertyDefinitions(java.lang.String, java.lang.String)

exportLogs

public byte[] exportLogs()
                  throws AdminException

Description copied from interface: ServerMonitoringAdmin

Export the server logs to a byte[]. The bytes contain the contents of a .zip file containing the logs.

Specified by:

exportLogs in interface ServerMonitoringAdmin

Returns:

the logs, as a byte[].

Throws:

AdminException

Since:

4.3

See Also:

ServerMonitoringAdmin.exportLogs()

trimString

protected static java.lang.String trimString(java.lang.String string)

Returns:

Return a trimmed, not null version of the specified string.

Since:

4.3