Defines the {@link com.metamatrix.admin.api.objects.AdminObject Administrative Objects} that are used in the Administrative API.
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.
Related Documentation
- MetaMatrix Administrator's Guide
@since 4.3