jp.go.nict.langrid.foundation.usermanagement

Class TemporaryUserManagement

java.lang.Object

jp.go.nict.langrid.foundation.AbstractLangridService

jp.go.nict.langrid.foundation.usermanagement.TemporaryUserManagement

All Implemented Interfaces:

TemporaryUserManagementService

public class TemporaryUserManagement
extends AbstractLangridService
implements TemporaryUserManagementService

Temporary user administration service. The temporary user inherits language service execution privileges from the parent user. When a temporary user calls a service, access control operates on the parent user's ID. Temporary users are valid only within 24 hours of the time of their activation. Thereafter they can no longer call services.

Version:

$Revision: 302 $

Author:

Takao Nakaguchi, $Author: t-nakaguchi $

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	addTemporaryUser(String userId, String password, Calendar beginAvailableDateTime) Adds temporary user.
void	clear() Clears all temporary user data.
void	clearExpiredUsers() Completely clears data of temporary user exceeding validity period.
void	deleteTemporaryUser(String userId) Deletes temporary user.
Calendar	getBeginAvailableDateTime(String userId) Gets initial usage date and time of temporary user.
Calendar	getEndAvailableDateTime(String userId) Gets initial usage date and time of temporary user.
TemporaryUserEntrySearchResult	searchTemporaryUsers(int startIndex, int maxCount, MatchingCondition[] conditions, Order[] orders) Searches temporary users.
void	setAvailableDateTimes(String userId, Calendar beginAvailableDateTime, Calendar endAvailableDateTime) Sets initial usage date and time of temporary user.

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

TemporaryUserManagement

public TemporaryUserManagement()

Constructor.

TemporaryUserManagement

public TemporaryUserManagement(ServiceContext serviceContext)

Constructor.

Parameters:

serviceContext - Service context

Method Detail

clear

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

Description copied from interface: TemporaryUserManagementService

Clears all temporary user data.

Specified by:

clear in interface TemporaryUserManagementService

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

clearExpiredUsers

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

Description copied from interface: TemporaryUserManagementService

Completely clears data of temporary user exceeding validity period.

Specified by:

clearExpiredUsers in interface TemporaryUserManagementService

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

searchTemporaryUsers

@ValidatedMethod
@AccessRightValidatedMethod
@TransactionMethod
public TemporaryUserEntrySearchResult searchTemporaryUsers(@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

Searches temporary users.

Searchable only by the temporary user registered by the user calling this API.

Specified by:

searchTemporaryUsers in interface TemporaryUserManagementService

Parameters:

startIndex - Start index

maxCount - Number of search results

conditions - Search conditions

orders - Sort order

Returns:

User search results

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

addTemporaryUser

@ValidatedMethod
@AccessRightValidatedMethod
@TransactionMethod
public void addTemporaryUser(@NotEmpty@ValidUserId
                                                                                 String userId,
                                                                                 @NotEmpty
                                                                                 String password,
                                                                                 @NotNull
                                                                                 Calendar beginAvailableDateTime)
                      throws AccessLimitExceededException,
                             InvalidParameterException,
                             InvalidUserIdException,
                             NoAccessPermissionException,
                             ServiceConfigurationException,
                             UnknownException,
                             UserAlreadyExistsException

Adds temporary user.

If a user ID already used by a user or temporary user is specified, throw InvalidUserIdException.

Specified by:

addTemporaryUser in interface TemporaryUserManagementService

Parameters:

userId - Temporary user ID

password - Password

beginAvailableDateTime - Starting date and time of validation

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

deleteTemporaryUser

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

Deletes temporary user.

Can be executed only by the temporary user registered by the user calling this API.

Specified by:

deleteTemporaryUser in interface TemporaryUserManagementService

Parameters:

userId - User ID 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

getBeginAvailableDateTime

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

Gets initial usage date and time of temporary user.

Can be executed only by the temporary user registered by the user calling this API.

Specified by:

getBeginAvailableDateTime in interface TemporaryUserManagementService

Parameters:

userId - Temporary Username

Returns:

Start date and time of usage

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

getEndAvailableDateTime

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

Gets initial usage date and time of temporary user.

Can be executed only by the temporary user registered by the user calling this API.

Specified by:

getEndAvailableDateTime in interface TemporaryUserManagementService

Parameters:

userId - Temporary Username

Returns:

End date and time of usage

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

setAvailableDateTimes

@ValidatedMethod
@AccessRightValidatedMethod
@TransactionMethod
public void setAvailableDateTimes(@NotEmpty@ValidUserId
                                                                                      String userId,
                                                                                      @NotNull
                                                                                      Calendar beginAvailableDateTime,
                                                                                      @NotNull
                                                                                      Calendar endAvailableDateTime)
                           throws AccessLimitExceededException,
                                  InvalidParameterException,
                                  NoAccessPermissionException,
                                  ServiceConfigurationException,
                                  UnknownException,
                                  UserNotFoundException

Sets initial usage date and time of temporary user.

Can be executed only by the temporary user registered by the user calling this API.

Specified by:

setAvailableDateTimes in interface TemporaryUserManagementService

Parameters:

userId - User ID

beginAvailableDateTime - Starting date and time of usage

endAvailableDateTime - Ending date and time of usage

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