jp.go.nict.langrid.foundation.usermanagement

Class UserManagement

java.lang.Object

jp.go.nict.langrid.foundation.AbstractLangridService

jp.go.nict.langrid.foundation.usermanagement.UserManagement

All Implemented Interfaces:

UserManagementService

public class UserManagement
extends AbstractLangridService
implements UserManagementService

User administration service.

Author:

Takao Nakaguchi

Constructor Summary

Constructors

Constructor and Description
UserManagement() Constructor.
UserManagement(ServiceContext serviceContext) Constructor.

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.
String	getUserPassword(String userId)
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.

Methods inherited from class jp.go.nict.langrid.foundation.AbstractLangridService

adjustDateFieldName, adjustDateFieldName, convert, convertException, convertException, convertException, convertException, convertException, convertException, convertException, convertException, convertException, convertUserOrder, copyAttributes, copyAttributes, copyProperties, getAccessLimitDao, getAccessLogDao, getAccessRightDao, getAccessStateDao, getConverter, getCoreNodeUrl, getDaoContext, getDaoFactory, getDefaultGridId, getFederationDao, getGridDao, getGridId, getNodeDao, getOverUseLimitDao, getOverUseStateDao, getResourceDao, getServiceContext, getServiceDao, getServiceDeploymentDao, getServiceLogic, getSystemPropertyDao, getTargetServiceIds, getTemporaryUserDao, getUserChecker, getUserDao, getUserLogic, unsetFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

UserManagement

public UserManagement()

Constructor.

UserManagement

public UserManagement(ServiceContext serviceContext)

Constructor.

Parameters:

serviceContext - Service context

Method Detail

clear

@AccessRightValidatedMethod(policy=ADMINONLY)
@TransactionMethod
public void clear()
           throws AccessLimitExceededException,
                  NoAccessPermissionException,
                  ServiceConfigurationException,
                  UnknownException

Description copied from interface: UserManagementService

Clears all user data.

Specified by:

clear in interface UserManagementService

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

@AccessRightValidatedMethod(policy=ADMINONLY)
@TransactionMethod
public void initialize()
                throws AccessLimitExceededException,
                       NoAccessPermissionException,
                       ServiceConfigurationException,
                       UnknownException

Description copied from interface: UserManagementService

Initializes user data. Call the UserDBInit.init method.

Specified by:

initialize in interface UserManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod
public UserEntrySearchResult searchUsers(@IntNotNegative
                                                                           int startIndex,
                                                                           @IntInRange(minimum=0,maximum=100)
                                                                           int maxCount,
                                                                           @NotNull@EachElement@ValidMatchingCondition
                                                                           MatchingCondition[] conditions,
                                                                           @NotNull@EachElement@ValidOrder
                                                                           Order[] orders)
                                  throws AccessLimitExceededException,
                                         InvalidParameterException,
                                         NoAccessPermissionException,
                                         ServiceConfigurationException,
                                         UnknownException,
                                         UnsupportedMatchingMethodException

Description copied from interface: UserManagementService

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.

Specified by:

searchUsers in interface UserManagementService

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

UnsupportedMatchingMethodException

searchUsersShouldChangePassword

@ValidatedMethod
@AccessRightValidatedMethod(policy=ADMINONLY)
@TransactionMethod
public UserEntrySearchResult searchUsersShouldChangePassword(@IntNotNegative
                                                                                                                                int startIndex,
                                                                                                                                @IntInRange(minimum=0,maximum=100)
                                                                                                                                int maxCount,
                                                                                                                                @IntNotNegative
                                                                                                                                int days,
                                                                                                                                @NotNull@EachElement@ValidOrder
                                                                                                                                Order[] orders)
                                                      throws AccessLimitExceededException,
                                                             InvalidParameterException,
                                                             NoAccessPermissionException,
                                                             ServiceConfigurationException,
                                                             UnknownException

Description copied from interface: UserManagementService

Returns users whose password must be changed.

Specified by:

searchUsersShouldChangePassword in interface UserManagementService

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

addUser

@ValidatedMethod
@AccessRightValidatedMethod(policy=ADMINONLY)
public void addUser(@NotEmpty@ValidUserId
                                                                     String userId,
                                                                     @NotEmpty
                                                                     String password,
                                                                     boolean canCallServices,
                                                                     @NotNull
                                                                     UserProfile profile,
                                                                     @NotNull@EachElement@ValidAttribute
                                                                     Attribute[] attributes)
             throws AccessLimitExceededException,
                    InvalidParameterException,
                    InvalidUserIdException,
                    NoAccessPermissionException,
                    ServiceConfigurationException,
                    UnknownException,
                    UserAlreadyExistsException

Description copied from interface: UserManagementService

Adds a user.

Specified by:

addUser in interface UserManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod(policy=ADMINONLY)
public void deleteUser(@NotEmpty@ValidUserId
                                                                        String userId)
                throws AccessLimitExceededException,
                       InvalidParameterException,
                       NoAccessPermissionException,
                       ServiceConfigurationException,
                       UnknownException,
                       UserNotFoundException

Description copied from interface: UserManagementService

Deletes a user.

Specified by:

deleteUser in interface UserManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod
@TransactionMethod
public UserProfile getUserProfile(@NotEmpty@ValidUserId
                                                                                      String userId)
                           throws AccessLimitExceededException,
                                  InvalidParameterException,
                                  NoAccessPermissionException,
                                  ServiceConfigurationException,
                                  UnknownException,
                                  UserNotFoundException

Description copied from interface: UserManagementService

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

Specified by:

getUserProfile in interface UserManagementService

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

@AccessRightValidatedMethod(policy=SELF_OR_ADMIN,
                            argNames="userId")
@ValidatedMethod
public void setUserProfile(@NotEmpty@ValidUserId
                                                                                        String userId,
                                                                                        @NotNull
                                                                                        UserProfile profile)
                    throws AccessLimitExceededException,
                           InvalidParameterException,
                           NoAccessPermissionException,
                           ServiceConfigurationException,
                           UnknownException,
                           UserNotFoundException

Description copied from interface: UserManagementService

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

Specified by:

setUserProfile in interface UserManagementService

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

@AccessRightValidatedMethod(policy=SELF_OR_ADMIN,
                            argNames="userId")
@ValidatedMethod
@TransactionMethod
public Attribute[] getUserAttributes(@NotEmpty@ValidUserId
                                                                                                                    String userId,
                                                                                                                    @NotNull@EachElement@ValidAttributeName
                                                                                                                    String[] attributeNames)
                              throws AccessLimitExceededException,
                                     InvalidParameterException,
                                     NoAccessPermissionException,
                                     ServiceConfigurationException,
                                     UnknownException,
                                     UserNotFoundException

Gets user's attribute data.

When an attribute name is specified that does not exist in attributeNames, that attribute name is ignored. When an empty string is set, gets all attributes which can be acquired.

Specified by:

getUserAttributes in interface UserManagementService

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

@AccessRightValidatedMethod(policy=SELF_OR_ADMIN,
                            argNames="userId")
@ValidatedMethod
@TransactionMethod
public void setUserAttributes(@NotEmpty@ValidUserId
                                                                                                             String userId,
                                                                                                             @NotNull@EachElement@ValidAttribute
                                                                                                             Attribute[] attributes)
                       throws AccessLimitExceededException,
                              InvalidParameterException,
                              NoAccessPermissionException,
                              ServiceConfigurationException,
                              UnknownException,
                              UserNotFoundException

Sets user's attribute data.

When the specified attribute's value field is an empty string, that attribute is deleted.

Specified by:

setUserAttributes in interface UserManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod(policy=SELF_OR_ADMIN,
                            argNames="userId")
@TransactionMethod
public void setUserPassword(@NotEmpty@ValidUserId
                                                                                                           String userId,
                                                                                                           @NotEmpty@ValidPassword
                                                                                                           String password)
                     throws AccessLimitExceededException,
                            InvalidParameterException,
                            NoAccessPermissionException,
                            ServiceConfigurationException,
                            UnknownException,
                            UserNotFoundException

Description copied from interface: UserManagementService

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

Specified by:

setUserPassword in interface UserManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod(policy=SELF_OR_ADMIN,
                            argNames="userId")
@TransactionMethod
public Calendar getPasswordChangedDate(@NotEmpty@ValidUserId
                                                                                                                      String userId)
                                throws AccessLimitExceededException,
                                       InvalidParameterException,
                                       NoAccessPermissionException,
                                       ServiceConfigurationException,
                                       UnknownException,
                                       UserNotFoundException

Description copied from interface: UserManagementService

Gets date of user password change.

Specified by:

getPasswordChangedDate in interface UserManagementService

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

getUserPassword

@ValidatedMethod
@AccessRightValidatedMethod(policy=ADMINONLY)
@TransactionMethod
public String getUserPassword(@NotEmpty@ValidUserId
                                                                                                 String userId)
                       throws AccessLimitExceededException,
                              InvalidParameterException,
                              NoAccessPermissionException,
                              ServiceConfigurationException,
                              UnknownException,
                              UserNotFoundException

Throws:

AccessLimitExceededException

InvalidParameterException

NoAccessPermissionException

ServiceConfigurationException

UnknownException

UserNotFoundException

getUserDigestedPassword

@ValidatedMethod
@AccessRightValidatedMethod(policy=ADMINONLY)
@TransactionMethod
public String getUserDigestedPassword(@NotEmpty@ValidUserId
                                                                                                         String userId)
                               throws AccessLimitExceededException,
                                      InvalidParameterException,
                                      NoAccessPermissionException,
                                      ServiceConfigurationException,
                                      UnknownException,
                                      UserNotFoundException

Description copied from interface: UserManagementService

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

Specified by:

getUserDigestedPassword in interface UserManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod(policy=SELF_OR_ADMIN)
@TransactionMethod
public boolean getUserCanCallServices(@NotEmpty@ValidUserId
                                                                                                             String userId)
                               throws AccessLimitExceededException,
                                      InvalidParameterException,
                                      NoAccessPermissionException,
                                      ServiceConfigurationException,
                                      UnknownException,
                                      UserNotFoundException

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

This data is always prioritized over access privilege and access restriction settings. If false, even with access permission and the access count and transfer size within permissible range, will not call the service.

Specified by:

getUserCanCallServices in interface UserManagementService

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

@ValidatedMethod
@AccessRightValidatedMethod(policy=ADMINONLY)
@TransactionMethod
public void setUserCanCallServices(@NotEmpty@ValidUserId
                                                                                                      String userId,
                                                                                                      boolean canCallServices)
                            throws AccessLimitExceededException,
                                   InvalidParameterException,
                                   NoAccessPermissionException,
                                   ServiceConfigurationException,
                                   UnknownException,
                                   UserNotFoundException

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

This data is always prioritized over access privilege and access restriction settings. If false, even with access permission and the access count and transfer size within permissible range, will not call the service.

Specified by:

setUserCanCallServices in interface UserManagementService

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