com.metamatrix.platform.admin.apiimpl
Interface IAdminHelper

All Known Implementing Classes:

AdminHelper

public interface IAdminHelper

Since:

4.3

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) Get the SessionToken and validate that the session is active for the specified MetaMatrixSessionID.

Method Detail

checkForRequiredRole

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.

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

SessionToken validateSession(MetaMatrixSessionID sessionID)
                             throws InvalidSessionException,
                                    ComponentNotFoundException

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

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