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

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

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

UserManagementService

public class UserManagement
extends AbstractLangridService
implements UserManagementService

ユーザ管理サービス。

作成者:

Takao Nakaguchi

コンストラクタの概要

UserManagement()
コンストラクタ。

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

メソッドの概要

void	addUser(String userId, String password, boolean canCallServices, UserProfile profile, Attribute[] attributes) ユーザを追加する。
void	clear() ユーザ情報を全てクリアする。
void	deleteUser(String userId) ユーザを削除する。
Calendar	getPasswordChangedDate(String userId) ユーザのパスワード変更日を取得する。
Attribute[]	getUserAttributes(String userId, String[] attributeNames) ユーザの属性情報を取得する。
boolean	getUserCanCallServices(String userId) ユーザが原子サービス、複合サービスを呼び出せるかどうかを取得する。
String	getUserDigestedPassword(String userId) ユーザのパスワードを取得する。
String	getUserPassword(String userId)
UserProfile	getUserProfile(String userId) ユーザのプロファイルを取得する。
void	initialize() ユーザ情報を初期化する。
UserEntrySearchResult	searchUsers(int startIndex, int maxCount, MatchingCondition[] conditions, Order[] orders) 指定された条件でユーザを検索し、ソートして返す。
UserEntrySearchResult	searchUsersShouldChangePassword(int startIndex, int maxCount, int days, Order[] orders) パスワード変更が必要なユーザを返す。
void	setUserAttributes(String userId, Attribute[] attributes) ユーザの属性情報を設定する。
void	setUserCanCallServices(String userId, boolean canCallServices) ユーザが原子サービス、複合サービスを呼び出せるかどうかを設定する。
void	setUserPassword(String userId, String password) ユーザのパスワードを変更する。
void	setUserProfile(String userId, UserProfile profile) ユーザのプロファイル情報を設定する。

クラス 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

コンストラクタの詳細

UserManagement

public UserManagement()

コンストラクタ。

UserManagement

public UserManagement(ServiceContext serviceContext)

コンストラクタ。

パラメータ:

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

メソッドの詳細

clear

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

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

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

定義:

インタフェース UserManagementService 内の clear

例外:

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

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

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

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

initialize

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

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

ユーザ情報を初期化する。 UserDBInit.initメソッドを呼び出す。

定義:

インタフェース UserManagementService 内の initialize

例外:

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

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

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

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

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

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

指定された条件でユーザを検索し、ソートして返す。 マッチング条件及びソート条件は、ユーザのプロファイル情報とインスタンス情報、 属性情報に対して設定可能。

定義:

インタフェース UserManagementService 内の searchUsers

パラメータ:

startIndex - 取得開始位置

maxCount - 最大取得件数

conditions - マッチング条件。AND検索

orders - ソート条件

戻り値:

検索結果のうち、startIndex、maxCountで指定された範囲の情報

例外:

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

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

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

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

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

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

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

パスワード変更が必要なユーザを返す。

定義:

インタフェース UserManagementService 内の searchUsersShouldChangePassword

パラメータ:

startIndex - 開始インデックス

maxCount - 最大件数

days - パスワード変更後の経過日数

orders - ソート順

戻り値:

パスワード変更が必要なユーザ

例外:

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

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

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

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

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

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

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

ユーザを追加する。

定義:

インタフェース UserManagementService 内の addUser

パラメータ:

userId - ユーザ名

password - パスワード

canCallServices - サービスを呼び出せるかどうか

profile - プロファイル

attributes - 属性

例外:

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

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

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

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

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

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

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

deleteUser

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

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

ユーザを削除する。

定義:

インタフェース UserManagementService 内の deleteUser

パラメータ:

userId - 削除するユーザのユーザ名

例外:

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

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

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

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

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

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

getUserProfile

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

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

ユーザのプロファイルを取得する。 管理者とユーザ本人がこのメソッドを実行できる。

定義:

インタフェース UserManagementService 内の getUserProfile

パラメータ:

userId - ユーザ名

戻り値:

プロファイル

例外:

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

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

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

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

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

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

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

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

ユーザのプロファイル情報を設定する。 管理者とユーザ本人がこのメソッドを実行できる。

定義:

インタフェース UserManagementService 内の setUserProfile

パラメータ:

userId - ユーザID

profile - ユーザのプロファイル情報

例外:

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

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

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

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

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

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

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

ユーザの属性情報を取得する。

attributeNamesに存在しない属性名が指定された場合、その属性名は無視される。 空配列を指定した場合は取得可能な全ての属性を取得する。

定義:

インタフェース UserManagementService 内の getUserAttributes

パラメータ:

userId - ユーザID

attributeNames - 取得する属性名の配列

戻り値:

ユーザの属性情報

例外:

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

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

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

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

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

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

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

ユーザの属性情報を設定する。

指定された属性のvalueフィールドが空文字列の場合、その属性は削除される。

定義:

インタフェース UserManagementService 内の setUserAttributes

パラメータ:

userId - ユーザID

attributes - 属性情報の配列。

例外:

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

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

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

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

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

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

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

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

ユーザのパスワードを変更する。 管理者とユーザ本人がこのメソッドを実行できる。

定義:

インタフェース UserManagementService 内の setUserPassword

パラメータ:

userId - ユーザ名

password - パスワード

例外:

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

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

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

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

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

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

getPasswordChangedDate

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

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

ユーザのパスワード変更日を取得する。

定義:

インタフェース UserManagementService 内の getPasswordChangedDate

パラメータ:

userId - ユーザ名

戻り値:

パスワード変更日

例外:

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

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

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

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

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

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

getUserPassword

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

例外:

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

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

ユーザのパスワードを取得する。 管理者のみこのメソッドを実行できる。 将来削除する。

定義:

インタフェース UserManagementService 内の getUserDigestedPassword

パラメータ:

userId - ユーザ名

戻り値:

パスワード

例外:

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

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

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

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

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

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

getUserCanCallServices

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

ユーザが原子サービス、複合サービスを呼び出せるかどうかを取得する。

この情報は全てのアクセス権設定、アクセス制限設定よりも優先されます。 falseであればアクセス許可があり、アクセス数や転送量が許容範囲内であってもサービス呼び出しは行えません。

定義:

インタフェース UserManagementService 内の getUserCanCallServices

パラメータ:

userId - ユーザ名

戻り値:

ユーザが原子サービス、複合サービスを呼び出せるかどうか

例外:

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

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

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

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

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

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

setUserCanCallServices

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

ユーザが原子サービス、複合サービスを呼び出せるかどうかを設定する。

この情報は全てのアクセス権設定、アクセス制限設定よりも優先されます。 falseであればアクセス許可があり、アクセス数や転送量が許容範囲内であってもサービス呼び出しは行えません。

定義:

インタフェース UserManagementService 内の setUserCanCallServices

パラメータ:

userId - ユーザ名

canCallServices - ユーザが原子サービス、複合サービスを呼び出せるかどうか

例外:

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

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

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

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

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

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