jpl.mipl.mdms.FileService.komodo.registry.aa
Interface AARegistry

All Known Implementing Classes:
LDAPAARegistry, MySQLAARegistry, MySQLRegistry, SybaseAARegistry, SybaseRegistry

public interface AARegistry

This interface defines the A&A requirement.

Since:
2.0
Version:
$Id: AARegistry.java,v 1.3 2009/09/05 03:24:37 awt Exp $
Author:
awt, {Adrian.Tinio@jpl.nasa.gov}

Method Summary
 void addUser(String name, String passwd, String privilege, boolean addVFT, RegistryHandler handler)
          Method to add a user to the registry.
 void addUserToRole(String name, String role, RegistryHandler handler)
          Method to add a user to a role.
 void changePassword(String name, String passwd, RegistryHandler handler)
          Method to change the user's password.
 void delUser(String name, RegistryHandler handler)
          Method to delete a user.
 void delUserFromRole(String name, String role, RegistryHandler handler)
          Method to delete a user from a role.
 int getUserFTCapabilities(String userName, RegistryHandler handler)
          Method to get the file type capabilities of a user.
 void getUserInfo(String userName, Authenticator auth, RegistryHandler handler)
          Method to get information on a particular user.
 void modifyUserPrivs(String name, String access, String value, RegistryHandler handler)
          Method to set the user's access level
 int showRolesForUser(String name, RegistryHandler handler)
          Method to show the roles for a given user.
 int showUsers(String name, RegistryHandler handler)
          Method to show the users on the server.
 int showUsersForRole(String role, RegistryHandler handler)
          Method to show the list of users for a given role.
 

Method Detail

getUserInfo

void getUserInfo(String userName,
                 Authenticator auth,
                 RegistryHandler handler)
Method to get information on a particular user.

Parameters:
userName - the user name
auth - the Authenticator object
handler - the registry handler

getUserFTCapabilities

int getUserFTCapabilities(String userName,
                          RegistryHandler handler)
Method to get the file type capabilities of a user.

Parameters:
userName - the user name
handler - the registry handler
Returns:
the file type capabilties

addUserToRole

void addUserToRole(String name,
                   String role,
                   RegistryHandler handler)
Method to add a user to a role.

Parameters:
name - the user name
role - the role name
handler - the registry handler

addUser

void addUser(String name,
             String passwd,
             String privilege,
             boolean addVFT,
             RegistryHandler handler)
Method to add a user to the registry.

Parameters:
name - the user name
passwd - the password
privilege - the privileges initially applied
addVFT - Can the user add vft's?
handler - the registry handler

changePassword

void changePassword(String name,
                    String passwd,
                    RegistryHandler handler)
Method to change the user's password.

Parameters:
name - the username
passwd - the password
handler - the registry handler

modifyUserPrivs

void modifyUserPrivs(String name,
                     String access,
                     String value,
                     RegistryHandler handler)
Method to set the user's access level

Parameters:
name - username
access - admin, read, write, vft
value - on, off
handler - registry handler

delUser

void delUser(String name,
             RegistryHandler handler)
Method to delete a user.

Parameters:
name - the user name
handler - the registry handler

delUserFromRole

void delUserFromRole(String name,
                     String role,
                     RegistryHandler handler)
Method to delete a user from a role.

Parameters:
name - the user name
role - the role name
handler - the registry handler

showRolesForUser

int showRolesForUser(String name,
                     RegistryHandler handler)
Method to show the roles for a given user.

Parameters:
name - the user name
handler - the registry handler
Returns:
the error code for this operation

showUsersForRole

int showUsersForRole(String role,
                     RegistryHandler handler)
Method to show the list of users for a given role. If the role is null, list each role with the list of users.

Parameters:
role - the role name
handler - the registry handler to handle results
Returns:
the error code for this operation

showUsers

int showUsers(String name,
              RegistryHandler handler)
Method to show the users on the server.

Parameters:
name - the user name
handler - the registry handler
Returns:
the error code for this operation