jp.go.nict.langrid.foundation.serviceaccesslimitmanagement

Class ServiceAccessLimitManagement

java.lang.Object

jp.go.nict.langrid.foundation.AbstractLangridService

jp.go.nict.langrid.foundation.serviceaccesslimitmanagement.ServiceAccessLimitManagement

All Implemented Interfaces:

ServiceAccessLimitManagementService

public class ServiceAccessLimitManagement
extends AbstractLangridService
implements ServiceAccessLimitManagementService

Access restriction administration service.

Version:

$Revision: 404 $

Author:

Takao Nakaguchi, $Author: t-nakaguchi $

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
void	clear() Deletes access restriction data.
void	deleteAccessLimit(String userId, String serviceId, String period, String limitType) Deletes access restriction.
AccessLimit[]	getMyAccessLimits(String serviceId) Gets the access restrictions set for the called service.
AccessLimitSearchResult	searchAccessLimits(int startIndex, int maxCount, String userId, String serviceId, Order[] orders) Searches access restriction data over the specified conditions, sorts and returns.
void	setAccessLimit(String userId, String serviceId, String period, String limitType, int limitCount) Sets access restriction.

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

ServiceAccessLimitManagement

public ServiceAccessLimitManagement()

Constructor.

ServiceAccessLimitManagement

public ServiceAccessLimitManagement(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: ServiceAccessLimitManagementService

Deletes access restriction data.

Specified by:

clear in interface ServiceAccessLimitManagementService

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

searchAccessLimits

@ValidatedMethod
@AccessRightValidatedMethod(policy=SERVICEOWNER_OR_ADMIN,
                            argNames="serviceId")
@TransactionMethod
public AccessLimitSearchResult searchAccessLimits(@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 restriction 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:

searchAccessLimits in interface ServiceAccessLimitManagementService

Parameters:

startIndex - Starting position of result acquisition

maxCount - Maximum number of acquired results

userId - Target user ID for searching access restriction

serviceId - Target service IDs of searched access restrictions

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

getMyAccessLimits

@AccessRightValidatedMethod
@TransactionMethod
@ValidatedMethod
public AccessLimit[] getMyAccessLimits(@NotEmpty@ValidServiceId
                                                                                           String serviceId)
                                throws AccessLimitExceededException,
                                       InvalidParameterException,
                                       NoAccessPermissionException,
                                       ServiceConfigurationException,
                                       UnknownException

Description copied from interface: ServiceAccessLimitManagementService

Gets the access restrictions set for the called service.

Specified by:

getMyAccessLimits in interface ServiceAccessLimitManagementService

Parameters:

serviceId - Service ID

Returns:

Array of access restrictions

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

setAccessLimit

@AccessRightValidatedMethod(policy=SERVICEOWNER_OR_ADMIN,
                            argNames="serviceId")
@TransactionMethod
@ValidatedMethod
public void setAccessLimit(@NotEmpty@ValidUserId(allowWildcard=true)
                                                                                                                  String userId,
                                                                                                                  @NotEmpty@ValidServiceId
                                                                                                                  String serviceId,
                                                                                                                  @NotEmpty@ValidEnum(value=Period.class)
                                                                                                                  String period,
                                                                                                                  @NotEmpty@ValidEnum(value=LimitType.class)
                                                                                                                  String limitType,
                                                                                                                  @IntNotNegative
                                                                                                                  int limitCount)
                    throws AccessLimitExceededException,
                           InvalidParameterException,
                           NoAccessPermissionException,
                           ServiceConfigurationException,
                           UnknownException

Sets access restriction. The access restriction data's ID is not used. Overwrites when the access restriction against the same user, service, period, or restriction 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:

setAccessLimit in interface ServiceAccessLimitManagementService

Parameters:

userId - User ID

serviceId - Service ID

period - Units of period

limitType - Restriction type

limitCount - Restriction value

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

deleteAccessLimit

@ValidatedMethod
@TransactionMethod
@AccessRightValidatedMethod(policy=SERVICEOWNER_OR_ADMIN,
                            argNames="serviceId")
public void deleteAccessLimit(@NotEmpty@ValidUserId(allowWildcard=true)
                                                                                                                     String userId,
                                                                                                                     @NotEmpty@ValidServiceId
                                                                                                                     String serviceId,
                                                                                                                     @NotEmpty@ValidEnum(value=Period.class)
                                                                                                                     String period,
                                                                                                                     @NotEmpty@ValidEnum(value=LimitType.class)
                                                                                                                     String limitType)
                       throws AccessLimitNotFoundException,
                              AccessLimitExceededException,
                              InvalidParameterException,
                              NoAccessPermissionException,
                              ServiceConfigurationException,
                              UnknownException

Description copied from interface: ServiceAccessLimitManagementService

Deletes access restriction.

Specified by:

deleteAccessLimit in interface ServiceAccessLimitManagementService

Parameters:

userId - User ID

serviceId - Service ID

period - Units of period

limitType - Restriction type

Throws:

AccessLimitNotFoundException - The access restriction does not exist

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