com.metamatrix.admin.api.server
Interface ServerAdmin

All Superinterfaces:

Admin, CoreConfigAdmin, CoreMonitoringAdmin, CoreRuntimeStateAdmin, CoreSecurityAdmin, ServerConfigAdmin, ServerMonitoringAdmin, ServerRuntimeStateAdmin, ServerSecurityAdmin

All Known Implementing Classes:

ServerAdminImpl

public interface ServerAdmin
extends ServerMonitoringAdmin, ServerConfigAdmin, ServerRuntimeStateAdmin, ServerSecurityAdmin, Admin

This is the primary facade interface to MetaMatrix server administrative functionality. The general design is to provide getters to retrieve lightweight data transfer objects (AdminObject) which are not "live" and do not communicate back to the server.

Generally, all objects have an identifier and each identifier form is specific to the object type. The identifiers taken by the methods in this interface may take generic identifiers (such as AdminObject.WILDCARD) to specify a set of objects to work on. The identifier forms and uniqueness constraints are specified in the javadoc for each particular object.

Since:

4.3

See Also:

AdminObject

Method Summary

void	close() Closes ServerAdmin connection to the server.

Methods inherited from interface com.metamatrix.admin.api.server.ServerMonitoringAdmin

exportLogs, getDQPs, getHosts, getProcesses, getResources, getServices

Methods inherited from interface com.metamatrix.admin.api.server.ServerConfigAdmin

addAuthorizationProvider, addHost, addProcess, assignBindingsToModel, deassignBindingFromModel, deassignBindingsFromModel, deleteHost, deleteProcess, disableHost, disableProcess, enableHost, enableProcess, generateMaterializationScripts, getBootstrapProperties, getClusterKey, getConnectorBindingsToConfigure, getServicesToConfigure, importConfiguration

Methods inherited from interface com.metamatrix.admin.api.server.ServerRuntimeStateAdmin

bounceSystem, startHost, startProcess, stopHost, stopProcess, stopSystem, synchronizeSystem

Methods inherited from interface com.metamatrix.admin.api.server.ServerSecurityAdmin

assignRoleToGroup, authenticateUser, exportDataRoles, getDomainNames, getGroups, getGroupsForDomain, getGroupsForUser, getRolesForGroup, getRolesForUser, importDataRoles, removeRoleFromGroup

Methods inherited from interface com.metamatrix.admin.api.core.CoreConfigAdmin

addConnectorArchive, addConnectorBinding, addConnectorBinding, addConnectorType, addExtensionModule, addUDF, addVDB, assignBindingToModel, deleteConnectorBinding, deleteConnectorType, deleteExtensionModule, deleteUDF, exportConfiguration, exportConnectorArchive, exportConnectorBinding, exportConnectorType, exportExtensionModule, exportVDB, getLogConfiguration, setLogConfiguration, setProperty, setSystemProperty, updateProperties, updateSystemProperties

Methods inherited from interface com.metamatrix.admin.api.core.CoreMonitoringAdmin

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

Methods inherited from interface com.metamatrix.admin.api.core.CoreRuntimeStateAdmin

cancelRequest, cancelSourceRequest, changeVDBStatus, clearCache, startConnectorBinding, stopConnectorBinding, terminateSession, terminateTransaction, terminateTransaction

Method Detail

close

@RolesAllowed(value="Anonymous")
void close()

Closes ServerAdmin connection to the server.

Since:

4.3