Defines the Adminstrative API that can be used against the MetaMatrix embeddable component. The main administrative interface for the embedded query service is {@link com.metamatrix.admin.api.embedded.EmbeddedAdmin}, which derives it's behavior from four components:

- {@link com.metamatrix.admin.api.embedded.EmbeddedConfigAdmin EmbeddedConfigAdmin} - methods to modify the system configuration
- {@link com.metamatrix.admin.api.embedded.EmbeddedMonitoringAdmin EmbeddedMonitoringAdmin} - methods to monitor the system state
- {@link com.metamatrix.admin.api.embedded.EmbeddedRuntimeStateAdmin EmbeddedRuntimeStateAdmin} - methods to modify the runtime state of the Server or the embedded query engine
- {@link com.metamatrix.admin.api.embedded.EmbeddedSecurityAdmin EmbeddedSecurityAdmin} - methods to change the security subsystem (users, groups, entitlements). Note that `EmbeddedSecurityAdmin` is simply a marker interface in the `embedded` package because the embedded service uses the security of the embedding application.

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 the query service, 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 unless passed through the Admin interfaces.
- Identifiers - each entity is identified by some identification scheme. Some identification schemes allow identifiers to use {@link com.metamatrix.admin.api.objects.AdminObject#WILDCARD} to indicate operations against all of the entities matching some part of the identifier spec. Almost all identifiers contain {@link com.metamatrix.admin.api.objects.AdminObject#DELIMITER}s to separate identifier comonents. 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