com.metamatrix.server.admin.apiimpl
Class QueryAdminAPIImpl

java.lang.Object
  com.metamatrix.platform.admin.apiimpl.SubSystemAdminAPIImpl
      com.metamatrix.server.admin.apiimpl.QueryAdminAPIImpl

All Implemented Interfaces:

SubSystemAdminAPI, QueryAdminAPI, java.io.Serializable

public class QueryAdminAPIImpl
extends SubSystemAdminAPIImpl
implements QueryAdminAPI

See Also:

Serialized Form

Method Summary

void	cancelRequest(RequestID requestID) Cancel a single query for the user session.
void	cancelRequest(RequestID requestID, int nodeID) Cancel an atomic query for the user session.
void	cancelRequests(MetaMatrixSessionID userSessionID) Cancel all queries for the user session.
java.util.Collection	getAllRequests() Return all queries that are in the system.
static QueryAdminAPI	getInstance()
java.util.Collection	getRequestsForSession(MetaMatrixSessionID userSessionID) Return all queries that are currently being processed for the user session.

Methods inherited from class com.metamatrix.platform.admin.apiimpl.SubSystemAdminAPIImpl

getSessionID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static QueryAdminAPI getInstance()
                                 throws MetaMatrixComponentException

Throws:

MetaMatrixComponentException

getAllRequests

public java.util.Collection getAllRequests()
                                    throws AuthorizationException,
                                           InvalidSessionException,
                                           MetaMatrixComponentException

Return all queries that are in the system.

Specified by:

getAllRequests in interface QueryAdminAPI

Parameters:

callerSessionID - ID of the caller's current session.

Returns:

a collection of Request objects.

Throws:

MetaMatrixComponentException - if an error occurs in communicating with a component.

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

getRequestsForSession

public java.util.Collection getRequestsForSession(MetaMatrixSessionID userSessionID)
                                           throws AuthorizationException,
                                                  InvalidSessionException,
                                                  MetaMatrixComponentException

Return all queries that are currently being processed for the user session.

Specified by:

getRequestsForSession in interface QueryAdminAPI

Parameters:

callerSessionID - ID of the caller's current session.

userSessionID - the primary identifier for the user account.

Returns:

a collection of Request objects.

Throws:

MetaMatrixComponentException - if an error occurs in communicating with a component.

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

cancelRequest

public void cancelRequest(RequestID requestID)
                   throws AuthorizationException,
                          InvalidSessionException,
                          InvalidRequestIDException,
                          MetaMatrixComponentException

Cancel a single query for the user session.

Specified by:

cancelRequest in interface QueryAdminAPI

Parameters:

callerSessionID - ID of the caller's current session.

requestID - the identifier of the query to be cancelled.

Throws:

InvalidRequestIDException - if the Request specified by the ID does not exist.

MetaMatrixComponentException - if an error occurs in communicating with a component.

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

cancelRequest

public void cancelRequest(RequestID requestID,
                          int nodeID)
                   throws AuthorizationException,
                          InvalidSessionException,
                          InvalidRequestIDException,
                          MetaMatrixComponentException

Cancel an atomic query for the user session.

Specified by:

cancelRequest in interface QueryAdminAPI

Parameters:

callerSessionID - ID of the caller's current session.

requestID - the identifier of the query that is running.

nodeid - identifies the atomic query to be cancelled.

Throws:

InvalidRequestIDException - if the Request specified by the ID does not exist.

MetaMatrixComponentException - if an error occurs in communicating with a component.

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

cancelRequests

public void cancelRequests(MetaMatrixSessionID userSessionID)
                    throws AuthorizationException,
                           InvalidSessionException,
                           MetaMatrixComponentException

Cancel all queries for the user session.

Specified by:

cancelRequests in interface QueryAdminAPI

Parameters:

callerSessionID - ID of the caller's current session.

userSessionID - the primary identifier for the user account.

Throws:

MetaMatrixComponentException - if an error occurs in communicating with a component.

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.