jp.go.nict.langrid.service_1_2.foundation.usermanagement

Interface UserManagementService

All Known Subinterfaces:

UserManagementService

All Known Implementing Classes:

UserManagement

public interface UserManagementService

The interface of the user administration service.

Version:

$Revision: 225 $

Author:

Takao Nakaguchi, $Author: t-nakaguchi $

Method Summary

Methods

Modifier and Type	Method and Description
void	addUser(String userId, String password, boolean canCallServices, UserProfile profile, Attribute[] attributes) Adds a user.
void	clear() Clears all user data.
void	deleteUser(String userId) Deletes a user.
Calendar	getPasswordChangedDate(String userId) Gets date of user password change.
Attribute[]	getUserAttributes(String userId, String[] attributeNames) Gets user's attribute data.
boolean	getUserCanCallServices(String userId) Gets whether or not user can call simple, composite services.
String	getUserDigestedPassword(String userId) Gets user's password.
UserProfile	getUserProfile(String userId) Gets user's profile.
void	initialize() Initializes user data.
UserEntrySearchResult	searchUsers(int startIndex, int maxCount, MatchingCondition[] conditions, Order[] orders) Searches users over the specified conditions, sorts and returns.
UserEntrySearchResult	searchUsersShouldChangePassword(int startIndex, int maxCount, int days, Order[] orders) Returns users whose password must be changed.
void	setUserAttributes(String userId, Attribute[] attributes) Sets user's attribute data.
void	setUserCanCallServices(String userId, boolean canCallServices) Sets whether or not user can call simple, composite services.
void	setUserPassword(String userId, String password) Changes user's password.
void	setUserProfile(String userId, UserProfile profile) Sets user profile data.

Method Detail

clear

void clear()
           throws AccessLimitExceededException,
                  NoAccessPermissionException,
                  ServiceConfigurationException,
                  UnknownException

Clears all user data.

Throws:

AccessLimitExceededException - Violated an access restriction

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unknwon exception occurred

initialize

void initialize()
                throws AccessLimitExceededException,
                       NoAccessPermissionException,
                       ServiceConfigurationException,
                       UnknownException

Initializes user data. Call the UserDBInit.init method.

Throws:

AccessLimitExceededException - Violated an access restriction

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unknwon exception occurred

searchUsers

UserEntrySearchResult searchUsers(int startIndex,
                                int maxCount,
                                MatchingCondition[] conditions,
                                Order[] orders)
                                  throws AccessLimitExceededException,
                                         InvalidParameterException,
                                         NoAccessPermissionException,
                                         ServiceConfigurationException,
                                         UnknownException

Searches users over the specified conditions, sorts and returns. Matching and sort conditions can be set on user profile data, instance data, and attribute data.

Parameters:

startIndex - Starting position of acquisition

maxCount - Maximum number of acquired results

conditions - Matching conditions. AND search

orders - Sort condition

Returns:

From among the search results, the data in the range specified by startIndex and maxCount

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

addUser

void addUser(String userId,
           String password,
           boolean canCallServices,
           UserProfile profile,
           Attribute[] attributes)
             throws AccessLimitExceededException,
                    InvalidParameterException,
                    InvalidUserIdException,
                    NoAccessPermissionException,
                    ServiceConfigurationException,
                    UnknownException,
                    UserAlreadyExistsException

Adds a user.

Parameters:

userId - Username

password - Password

canCallServices - Whether or not services can be called

profile - Profile

attributes - Attribute

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

InvalidUserIdException - An invalid user ID was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

UserAlreadyExistsException - The specified user already exists

deleteUser

void deleteUser(String userId)
                throws AccessLimitExceededException,
                       InvalidParameterException,
                       NoAccessPermissionException,
                       ServiceConfigurationException,
                       UnknownException,
                       UserNotFoundException

Deletes a user.

Parameters:

userId - Username of the user to be deleted

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

UserNotFoundException - The specified user does not exist

getUserProfile

UserProfile getUserProfile(String userId)
                           throws AccessLimitExceededException,
                                  InvalidParameterException,
                                  NoAccessPermissionException,
                                  ServiceConfigurationException,
                                  UnknownException,
                                  UserNotFoundException

Gets user's profile. The administrator and the user himself can execute this method.

Parameters:

userId - Username

Returns:

Profile

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

UserNotFoundException - The specified user does not exist

setUserProfile

void setUserProfile(String userId,
                  UserProfile profile)
                    throws AccessLimitExceededException,
                           InvalidParameterException,
                           NoAccessPermissionException,
                           ServiceConfigurationException,
                           UnknownException,
                           UserNotFoundException

Sets user profile data. The administrator and the user himself can execute this method.

Parameters:

userId - User ID

profile - User profile data

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

UserNotFoundException - The specified user was not found

getUserAttributes

Attribute[] getUserAttributes(String userId,
                            String[] attributeNames)
                              throws AccessLimitExceededException,
                                     InvalidParameterException,
                                     NoAccessPermissionException,
                                     ServiceConfigurationException,
                                     UnknownException,
                                     UserNotFoundException

Gets user's attribute data.

Parameters:

userId - User ID

attributeNames - Array of names of acquired attributes

Returns:

User attribute data

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

UserNotFoundException - The specified user was not found

setUserAttributes

void setUserAttributes(String userId,
                     Attribute[] attributes)
                       throws AccessLimitExceededException,
                              InvalidParameterException,
                              NoAccessPermissionException,
                              ServiceConfigurationException,
                              UnknownException,
                              UserNotFoundException

Sets user's attribute data.

Parameters:

userId - User ID

attributes - Array of attribute data.

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

UserNotFoundException - The specified user was not found

setUserPassword

void setUserPassword(String userId,
                   String password)
                     throws AccessLimitExceededException,
                            InvalidParameterException,
                            NoAccessPermissionException,
                            ServiceConfigurationException,
                            UnknownException,
                            UserNotFoundException

Changes user's password. The administrator and the user himself can execute this method.

Parameters:

userId - Username

password - Password

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

UserNotFoundException - The specified user does not exist

getPasswordChangedDate

Calendar getPasswordChangedDate(String userId)
                                throws AccessLimitExceededException,
                                       InvalidParameterException,
                                       NoAccessPermissionException,
                                       ServiceConfigurationException,
                                       UnknownException,
                                       UserNotFoundException

Gets date of user password change.

Parameters:

userId - Username

Returns:

Date of password change

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

UserNotFoundException - The specified user does not exist

getUserDigestedPassword

String getUserDigestedPassword(String userId)
                               throws AccessLimitExceededException,
                                      InvalidParameterException,
                                      NoAccessPermissionException,
                                      ServiceConfigurationException,
                                      UnknownException,
                                      UserNotFoundException

Gets user's password. Only the administrator can execute this method. Future deletion.

Parameters:

userId - Username

Returns:

Password

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

UserNotFoundException - The specified user does not exist

getUserCanCallServices

boolean getUserCanCallServices(String userId)
                               throws AccessLimitExceededException,
                                      InvalidParameterException,
                                      NoAccessPermissionException,
                                      ServiceConfigurationException,
                                      UnknownException,
                                      UserNotFoundException

Gets whether or not user can call simple, composite services.

Parameters:

userId - Username

Returns:

Whether or not the user can call simple and composite services

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

UserNotFoundException - The specified user does not exist

setUserCanCallServices

void setUserCanCallServices(String userId,
                          boolean canCallServices)
                            throws AccessLimitExceededException,
                                   InvalidParameterException,
                                   NoAccessPermissionException,
                                   ServiceConfigurationException,
                                   UnknownException,
                                   UserNotFoundException

Sets whether or not user can call simple, composite services.

Parameters:

userId - Username

canCallServices - Whether or not the user can call simple and composite services

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred

UserNotFoundException - The specified user does not exist

searchUsersShouldChangePassword

UserEntrySearchResult searchUsersShouldChangePassword(int startIndex,
                                                    int maxCount,
                                                    int days,
                                                    Order[] orders)
                                                      throws AccessLimitExceededException,
                                                             InvalidParameterException,
                                                             NoAccessPermissionException,
                                                             ServiceConfigurationException,
                                                             UnknownException

Returns users whose password must be changed.

Parameters:

startIndex - Start index

maxCount - Number of search results

days - Days elapsed since password change

orders - Sort order

Returns:

Users whose passwords must be changed

Throws:

AccessLimitExceededException - Violated an access restriction

InvalidParameterException - An invalid parameter was passed

NoAccessPermissionException - The user executing the call lacks execution privileges

ServiceConfigurationException - The service setup was not done appropriately

UnknownException - An unexpected exception occurred