Defines the Adminstrative API that can be used against the MetaMatrix
Server. The main administrative interface is {@link com.metamatrix.admin.api.server.ServerAdmin},
which derives it's behavior from four components:
- {@link com.metamatrix.admin.api.server.ServerConfigAdmin ServerConfigAdmin} - methods to modify the system configuration
- {@link com.metamatrix.admin.api.server.ServerMonitoringAdmin ServerMonitoringAdmin} - methods to monitor the system state
- {@link com.metamatrix.admin.api.server.ServerRuntimeStateAdmin ServerRuntimeStateAdmin} - methods to modify the runtime state of the Server or the embeddable component
- {@link com.metamatrix.admin.api.server.ServerSecurityAdmin ServerSecurityAdmin} - methods to change the security subsystem (users, groups, entitlements)
The Adminstrative API methods generally indicate one or more administrative objects
using identifiers, then indicate an action to perform using some parameters.
- Administrative objects - all of the different entities that can be modified in the
MetaMatrix system such as a Host, Process, VDB, User, etc. All of the administrative objects
extend from the {@link com.metamatrix.admin.api.objects.AdminObject} interface. These objects are light-weight data transfer
objects that are returned from the Admin interfaces. These objects are not "live" and changes
do not affect the system state unless passed through the Admin interfaces.
- Identifiers - each entity is identified by some identification scheme. Some identification
schemes allow wildcard identifiers to indicate operations against all of the entities matching
some part of the identifier spec. The entity-specific identification scheme is explained
in the javadoc and documentation for the particular {@link com.metamatrix.admin.api.objects.AdminObject AdminObject}
in question.
- Actions - to perform on the objects such as getting, setting, adding, or
removing entities.
- Parameters - depending on the objects and actions to perform, these provide more information.
Usage
java.sql.Connection connection = // Obtain a MetaMatrix JDBC connection...
// Cast jdbc.Connection to MetaMatrix extended connection
com.metamatrix.jdbc.api.Connection mmconn = (com.metamatrix.jdbc.api.Connection)connection;
// Get a handle to the Admin
Admin admin = null;
try {
mmconn.getAdminAPI();
} catch (SQLException err) {
//...
}
// Get all open sessions to the server
Collection sessions = admin.getSessions("*");
// Iterate through all server sessions...
// Close the connection
try {
mmconn.close();
} catch (SQLException err) {
//...
}
Related Documentation
- MetaMatrix Administrator's Guide
@since 4.3