com.metamatrix.admin.api.server
Interface ServerMonitoringAdmin

All Superinterfaces:

MonitoringAdmin

All Known Subinterfaces:

ServerAdmin

All Known Implementing Classes:

ServerAdminImpl, ServerMonitoringAdminImpl

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

Interface that exposes the MetaMatrix server for system monitoring.

Clients should not code directly to this interface but should instead use ServerAdmin.

Since:

4.3

Method Summary

byte[]	exportLogs() Export the server logs to a byte[].
java.util.Collection	getDQPs(java.lang.String identifier) Get the DQPs that correspond to the specified identifer pattern.
java.util.Collection	getHosts(java.lang.String hostIdentifier) Get the hosts that correspond to the specified identifier pattern.
java.util.Collection	getProcesses(java.lang.String processIdentifier) Get the processes that correspond to the specified identifier pattern.
java.util.Collection	getResources(java.lang.String resourceIdentifier) Get the Resources that correspond to the specified identifer pattern.
java.util.Collection	getServices(java.lang.String identifier) Get the Services that correspond to the specified identifer pattern.

Methods inherited from interface org.teiid.adminapi.MonitoringAdmin

getCaches, getConnectionPoolStats, getConnectorBindings, getConnectorBindingsInVDB, getConnectorTypePropertyDefinitions, getConnectorTypes, getExtensionModules, getQueueWorkerPools, getRequests, getSessions, getSourceRequests, getTransactions, getVDBs

Method Detail

getHosts

java.util.Collection getHosts(java.lang.String hostIdentifier)
                              throws AdminException

Get the hosts that correspond to the specified identifier pattern.

Parameters:

hostIdentifier - the unique identifier for for a Host in the system or "WILDCARD" if all hosts are desired.

Returns:

Collection of Host

Throws:

AdminException - if there's a system error.

Since:

4.3

getProcesses

@RolesAllowed(value="Anonymous")
java.util.Collection getProcesses(java.lang.String processIdentifier)
                                  throws AdminException

Get the processes that correspond to the specified identifier pattern.

Specified by:

getProcesses in interface MonitoringAdmin

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

getServices

java.util.Collection getServices(java.lang.String identifier)
                                 throws AdminException

Get the Services that correspond to the specified identifer pattern. These services represent what is defined for a given Host | Process;

Parameters:

resourceIdentifier - the unique identifier for for a Service in the system or "WILDCARD" if all Services are desired.

Returns:

Collection of Service

Throws:

AdminException - if there's a system error.

Since:

6.1

getResources

java.util.Collection getResources(java.lang.String resourceIdentifier)
                                  throws AdminException

Get the Resources that correspond to the specified identifer pattern.

Parameters:

resourceIdentifier - the unique resourceIdentifier for for a Resource in the system or "WILDCARD" if all Resources are desired.

Returns:

Collection of Resource

Throws:

AdminException - if there's a system error.

Since:

4.3

getDQPs

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

Get the DQPs that correspond to the specified identifer pattern.

Parameters:

identifier - the unique identifier for for a DQP in the system or "WILDCARD" if all Resources are desired.

Returns:

Collection of DQP

Throws:

AdminException - if there's a system error.

Since:

4.3

exportLogs

byte[] exportLogs()
                  throws AdminException

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

Returns:

the logs, as a byte[].

Throws:

AdminException

Since:

4.3