jp.go.nict.langrid.foundation.usermanagement
クラス TemporaryUserManagement

java.lang.Object
  jp.go.nict.langrid.foundation.AbstractLangridService
      jp.go.nict.langrid.foundation.usermanagement.TemporaryUserManagement

すべての実装されたインタフェース:

TemporaryUserManagementService

public class TemporaryUserManagement
extends AbstractLangridService
implements TemporaryUserManagementService

一時ユーザ管理サービス。一時ユーザは、親ユーザの言語サービス実行権限を引き継ぐ。 一時ユーザがサービスを呼び出すと、親ユーザのIDでアクセス制御が行われる。 一時ユーザは有効開始日時から24時間以内のみ有効。それ以降はサービスを呼び出せなくなる。

バージョン:

$Revision: 10556 $

作成者:

Takao Nakaguchi, $Author: Takao Nakaguchi $

コンストラクタの概要

TemporaryUserManagement()
コンストラクタ。

TemporaryUserManagement(ServiceContext serviceContext)
コンストラクタ。

メソッドの概要

void	addTemporaryUser(String userId, String password, Calendar beginAvailableDateTime) 一時ユーザを追加する。
void	clear() 一時ユーザ情報を全てクリアする。
void	clearExpiredUsers() 有効期限の過ぎた一時ユーザ情報を全てクリアする。
void	deleteTemporaryUser(String userId) 一時ユーザを削除する。
Calendar	getBeginAvailableDateTime(String userId) 一時ユーザの利用開始日時を取得する。
Calendar	getEndAvailableDateTime(String userId) 一時ユーザの利用終了日時を取得する。
TemporaryUserEntrySearchResult	searchTemporaryUsers(int startIndex, int maxCount, MatchingCondition[] conditions, Order[] orders) 一時ユーザを検索する。
void	setAvailableDateTimes(String userId, Calendar beginAvailableDateTime, Calendar endAvailableDateTime) 一時ユーザの利用期間を設定する。

クラス 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, getSubscriptionLogic, getSystemPropertyDao, getTargetServiceIds, getTemporaryUserDao, getUserChecker, getUserDao, getUserLogic, unsetFactory

クラス java.lang.Object から継承されたメソッド

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

コンストラクタの詳細

TemporaryUserManagement

public TemporaryUserManagement()

コンストラクタ。

TemporaryUserManagement

public TemporaryUserManagement(ServiceContext serviceContext)

コンストラクタ。

パラメータ:

serviceContext - サービスコンテキスト

メソッドの詳細

clear

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

インタフェース TemporaryUserManagementService の記述:

一時ユーザ情報を全てクリアする。

定義:

インタフェース TemporaryUserManagementService 内の clear

例外:

AccessLimitExceededException - アクセス制限に違反した

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスの設定が適切に行われていない

UnknownException - 不明な例外が発生した

clearExpiredUsers

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

インタフェース TemporaryUserManagementService の記述:

有効期限の過ぎた一時ユーザ情報を全てクリアする。

定義:

インタフェース TemporaryUserManagementService 内の clearExpiredUsers

例外:

AccessLimitExceededException - アクセス制限に違反した

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスの設定が適切に行われていない

UnknownException - 不明な例外が発生した

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

一時ユーザを検索する。

このAPIを呼び出したユーザが登録した一時ユーザのみ検索可能。

定義:

インタフェース TemporaryUserManagementService 内の searchTemporaryUsers

パラメータ:

startIndex - 開始インデックス

maxCount - 最大件数

conditions - 検索条件

orders - ソート順

戻り値:

ユーザの検索結果

例外:

AccessLimitExceededException - アクセス制限に違反した

InvalidParameterException - 不正なパラメータが渡された

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスの設定が適切に行われていない

UnknownException - 想定されない例外が発生した

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

一時ユーザを追加する。

既に一時ユーザ又はユーザが使用しているユーザIDが指定された場合、InvalidUserIdExceptionが発生する。

定義:

インタフェース TemporaryUserManagementService 内の addTemporaryUser

パラメータ:

userId - 一時ユーザID

password - パスワード

beginAvailableDateTime - 有効化開始日時

例外:

AccessLimitExceededException - アクセス制限に違反した

InvalidParameterException - 不正なパラメータが渡された

InvalidUserIdException - 不正なユーザIDが渡された

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスの設定が適切に行われていない

UnknownException - 想定されない例外が発生した

UserAlreadyExistsException - 指定されたユーザは既に存在する

deleteTemporaryUser

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

一時ユーザを削除する。

このAPIを呼び出したユーザが登録した一時ユーザに対してのみ実行可能。

定義:

インタフェース TemporaryUserManagementService 内の deleteTemporaryUser

パラメータ:

userId - 削除する一時ユーザのID

例外:

AccessLimitExceededException - アクセス制限に違反した

InvalidParameterException - 不正なパラメータが渡された

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスの設定が適切に行われていない

UnknownException - 想定されない例外が発生した

UserNotFoundException - 指定されたユーザは存在しない

getBeginAvailableDateTime

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

一時ユーザの利用開始日時を取得する。

このAPIを呼び出したユーザが登録した一時ユーザに対してのみ実行可能。

定義:

インタフェース TemporaryUserManagementService 内の getBeginAvailableDateTime

パラメータ:

userId - 一時ユーザ名

戻り値:

利用開始日時

例外:

AccessLimitExceededException - アクセス制限に違反した

InvalidParameterException - 不正なパラメータが渡された

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスの設定が適切に行われていない

UnknownException - 想定されない例外が発生した

UserNotFoundException - 指定されたユーザは存在しない

getEndAvailableDateTime

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

一時ユーザの利用終了日時を取得する。

このAPIを呼び出したユーザが登録した一時ユーザに対してのみ実行可能。

定義:

インタフェース TemporaryUserManagementService 内の getEndAvailableDateTime

パラメータ:

userId - 一時ユーザ名

戻り値:

利用終了日時

例外:

AccessLimitExceededException - アクセス制限に違反した

InvalidParameterException - 不正なパラメータが渡された

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスの設定が適切に行われていない

UnknownException - 想定されない例外が発生した

UserNotFoundException - 指定されたユーザは存在しない

setAvailableDateTimes

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

一時ユーザの利用期間を設定する。

このAPIを呼び出したユーザが登録した一時ユーザに対してのみ実行可能。

定義:

インタフェース TemporaryUserManagementService 内の setAvailableDateTimes

パラメータ:

userId - ユーザID

beginAvailableDateTime - 利用開始日時

endAvailableDateTime - 利用終了日時

例外:

AccessLimitExceededException - アクセス制限に違反した

InvalidParameterException - 不正なパラメータが渡された

NoAccessPermissionException - 呼び出しを行ったユーザに実行権限が無い

ServiceConfigurationException - サービスの設定が適切に行われていない

UnknownException - 想定されない例外が発生した

UserNotFoundException - 指定されたユーザが見つからない