org.hardtokenmgmt.admin.control
Interface IAdministratorPriviledgesManager

All Known Implementing Classes:

AdministratorPriviledgesManagerWrapper, DummyImpl, HTMFWSImpl

public interface IAdministratorPriviledgesManager

Interface in charge of managing an organizations administrators, to add, remove and list for the different groups.

Version:

$Id$

Author:

Philip Vendil 14 mar 2009

Method Summary

void	editAdmin(AdminDataVO adminData) Adds/edits the data of a given administrator.
boolean	existsAdministrator(AdminDataVO adminData) Checks if an administrator already exists.
java.util.List<AdminDataVO>	getAdministrators(java.lang.String orgId) Returns a list of administrators belonging to the given organization
java.util.List<AdminGroupVO>	getAvailableAdminGroups(java.lang.String orgId) Returns the available administration groups for the given organization.
void	removeAdministrator(AdminDataVO adminData) Removes the administrator privileges from a user.

Method Detail

getAvailableAdminGroups

java.util.List<AdminGroupVO> getAvailableAdminGroups(java.lang.String orgId)
                                                     throws java.io.IOException,
                                                            org.hardtokenmgmt.ws.gen.AuthorizationDeniedException_Exception

Returns the available administration groups for the given organization.

Parameters:

orgId - the unique id of the organization

Returns:

a list of administration groups

Throws:

java.io.IOException - if communication problems occurred.

org.hardtokenmgmt.ws.gen.AuthorizationDeniedException_Exception - if the administrator wasn't authorized to perform the given operation.

getAdministrators

java.util.List<AdminDataVO> getAdministrators(java.lang.String orgId)
                                              throws java.io.IOException,
                                                     org.hardtokenmgmt.ws.gen.AuthorizationDeniedException_Exception

Returns a list of administrators belonging to the given organization

Parameters:

orgId - the unique id of the organization

Returns:

all administrators belonging to the organization.

Throws:

java.io.IOException - if communication problems occurred.

org.hardtokenmgmt.ws.gen.AuthorizationDeniedException_Exception - if the administrator wasn't authorized to perform the given operation.

editAdmin

void editAdmin(AdminDataVO adminData)
               throws java.io.IOException,
                      org.hardtokenmgmt.ws.gen.AuthorizationDeniedException_Exception,
                      AdminDataException

Adds/edits the data of a given administrator.

Parameters:

adminData - information about the administrator and the administration groups he should belong to.

Throws:

java.io.IOException - if communication problems occurred.

org.hardtokenmgmt.ws.gen.AuthorizationDeniedException_Exception - if the administrator wasn't authorized to perform the given operation.

AdminDataException - if the adminData parameter contained erroneous data.

removeAdministrator

void removeAdministrator(AdminDataVO adminData)
                         throws java.io.IOException,
                                org.hardtokenmgmt.ws.gen.AuthorizationDeniedException_Exception,
                                AdminDataException

Removes the administrator privileges from a user.

Parameters:

adminData - information about the administrator.

Throws:

java.io.IOException - if communication problems occurred.

org.hardtokenmgmt.ws.gen.AuthorizationDeniedException_Exception - if the administrator wasn't authorized to perform the given operation.

AdminDataException - if the adminData parameter contained erroneous data.

existsAdministrator

boolean existsAdministrator(AdminDataVO adminData)
                            throws java.io.IOException,
                                   org.hardtokenmgmt.ws.gen.AuthorizationDeniedException_Exception

Checks if an administrator already exists.

Parameters:

adminData - information about the administrator.

Returns:

true if the given administrator already exists

Throws:

java.io.IOException - if communication problems occurred.

org.hardtokenmgmt.ws.gen.AuthorizationDeniedException_Exception - if the administrator wasn't authorized to perform the given operation.