jp.go.nict.langrid.foundation.serviceaccessrightmanagement

Class ServiceAccessRightManagement

java.lang.Object

jp.go.nict.langrid.foundation.AbstractLangridService

jp.go.nict.langrid.foundation.serviceaccessrightmanagement.ServiceAccessRightManagement

All Implemented Interfaces:

ServiceAccessRightManagementService

public class ServiceAccessRightManagement
extends AbstractLangridService
implements ServiceAccessRightManagementService

Access privilege administration service.

Version:

$Revision:5350 $

Author:

Takao Nakaguchi, $Author:nakaguchi $

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Deletes access privilege data.
void	deleteAccessRight(String userId, String serviceId) Deletes access privilege.
AccessRight	getMyAccessRight(String serviceId) Searches access privilege data of the called user.
AccessRightSearchResult	searchAccessRights(int startIndex, int maxCount, String userId, String serviceId, Order[] orders) Searches access privilege data over the specified conditions, sorts and returns.
void	setAccessRight(String userId, String serviceId, boolean permitted) Sets access privilege.

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

ServiceAccessRightManagement

public ServiceAccessRightManagement()

Constructor.

ServiceAccessRightManagement

public ServiceAccessRightManagement(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: ServiceAccessRightManagementService

Deletes access privilege data.

Specified by:

clear in interface ServiceAccessRightManagementService

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 unexpected exception occurred

searchAccessRights

@ValidatedMethod
@AccessRightValidatedMethod(policy=SERVICEOWNER_OR_ADMIN,
                            argNames="serviceId")
@TransactionMethod
public AccessRightSearchResult searchAccessRights(@IntNotNegative
                                                                                                                                         int startIndex,
                                                                                                                                         @IntInRange(minimum=0,maximum=100)
                                                                                                                                         int maxCount,
                                                                                                                                         @NotNull@ValidUserId(allowWildcard=true,allowEmpty=true)
                                                                                                                                         String userId,
                                                                                                                                         @NotNull@ValidServiceId(allowWildcard=true,allowEmpty=true)
                                                                                                                                         String serviceId,
                                                                                                                                         @NotNull@EachElement@ValidOrder
                                                                                                                                         Order[] orders)
                                           throws AccessLimitExceededException,
                                                  InvalidParameterException,
                                                  NoAccessPermissionException,
                                                  ServiceConfigurationException,
                                                  UnknownException

Searches access privilege data over the specified conditions, sorts and returns.

When userId and serviceId are omitted, specifies an empty string. When userId is omitted, search data of all users. When serviceId is omitted, search data of all services registered by the user calling this method.

Specified by:

searchAccessRights in interface ServiceAccessRightManagementService

Parameters:

startIndex - Starting position of result acquisition

maxCount - Maximum number of acquired results

userId - Target user ID for searching access privilege

serviceId - Target service IDs of searched access privileges

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

getMyAccessRight

@AccessRightValidatedMethod
@TransactionMethod
@ValidatedMethod
public AccessRight getMyAccessRight(@NotEmpty@ValidServiceId
                                                                                        String serviceId)
                             throws AccessLimitExceededException,
                                    InvalidParameterException,
                                    NoAccessPermissionException,
                                    ServiceConfigurationException,
                                    UnknownException

Description copied from interface: ServiceAccessRightManagementService

Searches access privilege data of the called user.

Specified by:

getMyAccessRight in interface ServiceAccessRightManagementService

Parameters:

serviceId - Service ID

Returns:

Access permission

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

setAccessRight

@AccessRightValidatedMethod(policy=SERVICEOWNER_OR_ADMIN,
                            argNames="serviceId")
@TransactionMethod
@ValidatedMethod
public void setAccessRight(@NotEmpty@ValidUserId(allowWildcard=true)
                                                                                                                  String userId,
                                                                                                                  @NotEmpty@ValidServiceId
                                                                                                                  String serviceId,
                                                                                                                  boolean permitted)
                    throws AccessLimitExceededException,
                           InvalidParameterException,
                           NoAccessPermissionException,
                           ServiceConfigurationException,
                           UnknownException

Sets access privilege. Overwrites when the access privilege against the same user or service is already set.

By setting userID to "*", you can set the service's defined value of the service (the value applied to newly added services).

Specified by:

setAccessRight in interface ServiceAccessRightManagementService

Parameters:

userId - User ID

serviceId - Service ID

permitted - Whether permitted or not

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

deleteAccessRight

@ValidatedMethod
@AccessRightValidatedMethod(policy=SERVICEOWNER_OR_ADMIN,
                            argNames="serviceId")
@TransactionMethod
public void deleteAccessRight(@NotEmpty@ValidUserId
                                                                                                                     String userId,
                                                                                                                     @NotEmpty@ValidServiceId
                                                                                                                     String serviceId)
                       throws AccessLimitExceededException,
                              AccessRightNotFoundException,
                              InvalidParameterException,
                              NoAccessPermissionException,
                              ServiceConfigurationException,
                              UnknownException

Description copied from interface: ServiceAccessRightManagementService

Deletes access privilege.

Specified by:

deleteAccessRight in interface ServiceAccessRightManagementService

Parameters:

userId - Target user ID of the access privilege to be deleted. To specify all, use "*"

serviceId - Target service IDs of access privileges to be deleted. To specify all, use "*"

Throws:

AccessLimitExceededException - Violated an access restriction

AccessRightNotFoundException - The access privilege does not exist

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