com.metamatrix.platform.admin.apiimpl
Class AdminHelper

java.lang.Object
  com.metamatrix.platform.admin.apiimpl.AdminHelper

All Implemented Interfaces:

IAdminHelper

public class AdminHelper
extends java.lang.Object
implements IAdminHelper

This class is used by all AdminAPIImpl to do general tasks such as session vlidation and authorization role checking.

Constructor Summary

AdminHelper()
ctor

Method Summary

void	checkForRequiredRole(SessionToken adminToken, java.lang.String roleName) Checks that user is in the necessary role, throws an exception if not.
SessionToken	validateSession(MetaMatrixSessionID sessionID) Deprecated. use DQPWorkContext instead

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminHelper

public AdminHelper()

ctor

Method Detail

checkForRequiredRole

public void checkForRequiredRole(SessionToken adminToken,
                                 java.lang.String roleName)
                          throws AuthorizationException,
                                 ComponentNotFoundException

Checks that user is in the necessary role, throws an exception if not. Methods of this administrative API may require that a caller be in one or more security roles.

Specified by:

checkForRequiredRole in interface IAdminHelper

Parameters:

adminToken - a valid SessionToken object representing the session of the caller attempting an administrative operation

roleName - String name of role to be checked for caller membership

Throws:

AuthorizationException - if caller is not in the role, and therefore not authorized to make the operation

ComponentNotFoundException - if the authorization service could not be communicated with due to a bad service instance or proxy

validateSession

public SessionToken validateSession(MetaMatrixSessionID sessionID)
                             throws InvalidSessionException,
                                    ComponentNotFoundException

Deprecated. use DQPWorkContext instead

Get the SessionToken and validate that the session is active for the specified MetaMatrixSessionID.

Specified by:

validateSession in interface IAdminHelper

Parameters:

sessionID - the MetaMatrixSessionID for the session in question.

Returns:

The SessionToken for the session in question.

Throws:

InvalidSessionException - If session has expired or doesn't exist

ComponentNotFoundException - If couldn't find needed service component