概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド

## com.JRcServer.commons.sys.user
クラス UserManager

    java.lang.Object
      com.JRcServer.commons.sys.user.UserManager

    public class UserManager

extends java.lang.Object

ユーザマネージャ.
ユーザの管理をサポートします.

導入されたバージョン:
  JRcCommons 1.00
バージョン:
  2005/09/18
作成者:
  masahito suzuki

フィールドの概要
`static java.lang.String` | `GUEST_USER` GUESTユーザ名.
`static java.lang.String` | `ROOT_USER` ROOTユーザ名.

コンストラクタの概要
`UserManager(java.lang.String name)` コンストラクタ.
`UserManager(java.lang.String name, long timing)` コンストラクタ.

メソッドの概要
`void` | `addUser(java.lang.String user, java.lang.String passwd)` ユーザ追加.
`void` | `addUser(java.lang.String user, java.lang.String passwd, boolean rootOwner, boolean rootGroup)` ユーザ追加.
`void` | `addUser(java.lang.String user, java.lang.String passwd, boolean rootOwner, boolean rootGroup, int max, java.lang.String[] extension)` ユーザ追加.
`void` | `addUserCount(java.lang.String user)` 対象ユーザのログインカウントを１インクリメント.
`void` | `destroy()` ユーザ管理オブジェクトを破棄.
`java.lang.String[]` | `getExtension(java.lang.String user)` 対象ユーザに対する拡張情報を取得.
`int` | `getMaxUserCount(java.lang.String user)` 対象ユーザに対する最大接続数を取得.
`int` | `getNowUserCount(java.lang.String user)` 対象ユーザに対する現在の接続数を取得.
`java.lang.String` | `getPasswd(java.lang.String user)` 対象ユーザに対するパスワード取得.
`boolean` | `getRootGroupOwner(java.lang.String user)` 対象ユーザに対するルートグループ権限を取得.
`boolean` | `getRootOwner(java.lang.String user)` 対象ユーザに対するルート権限を取得.
`java.lang.String` | `getUserIDByUserName(int id)` ユーザIDに対するユーザ名を取得.
`int` | `getUserLength()` ユーザ名数を取得.
`int` | `getUserNameByUserID(java.lang.String user)` ユーザ名に対するユーザIDを取得.
`java.lang.String[]` | `getUsers()` ユーザ名一覧を取得.
`boolean` | `isUser(java.lang.String user)` ユーザ存在チェック.
`boolean` | `isUserPasswd(java.lang.String user, java.lang.String passwd)` 対象ユーザ名のパスワードが正しいかチェック.
`boolean` | `isUseUser(java.lang.String user)` 利用可能ユーザチェック.
`void` | `removeUser(java.lang.String user)` ユーザ削除.
`void` | `removeUserCount(java.lang.String user)` 対象ユーザのログインカウントを１デクリメント.
`void` | `renewExtension(java.lang.String user, java.lang.String[] newExtension)` 対象ユーザに対する拡張情報を変更.
`void` | `renewMaxUserCount(java.lang.String user, int newMax)` 対象ユーザに対する最大接続数を変更.
`void` | `renewPasswd(java.lang.String user, java.lang.String newPasswd)` 対象ユーザに対するパスワード変更.
`void` | `renewRootGroup(java.lang.String user, boolean group)` 対象ユーザに対するROOTグループを変更.
`void` | `renewRootOwner(java.lang.String user, boolean owner)` 対象ユーザに対するROOT権限を変更.

クラス java.lang.Object から継承されたメソッド
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

フィールドの詳細

### ROOT_USER

    public static final java.lang.String ROOT_USER

  ROOTユーザ名.

  関連項目:
    定数フィールド値

### GUEST_USER

    public static final java.lang.String GUEST_USER

  GUESTユーザ名.

  関連項目:
    定数フィールド値

コンストラクタの詳細

### UserManager

    public UserManager(java.lang.String name)
                throws InputException,
                       AccessException

  コンストラクタ.
  ユーザ管理オブジェクトを生成します.

  パラメータ:
    `name` - 対象のファイル名を設定します.
  例外:
    `InputException` - 入力例外.
    `AccessException` - アクセス例外.

### UserManager

    public UserManager(java.lang.String name,
                       long timing)
                throws InputException,
                       AccessException

  コンストラクタ.
  ユーザ管理オブジェクトを生成します.

  パラメータ:
    `name` - 対象のファイル名を設定します.
    `timing` - データがアップデートされてからの保存間隔を設定します.
    また、指定単位はミリ秒です.
  例外:
    `InputException` - 入力例外.
    `AccessException` - アクセス例外.

メソッドの詳細

### destroy

    public final void destroy()

  ユーザ管理オブジェクトを破棄.
  対象のユーザ管理オブジェクトを破棄します.

### addUser

    public final void addUser(java.lang.String user,
                              java.lang.String passwd)
                       throws InputException

  ユーザ追加.
  ユーザ情報を追加します.
  また、最大接続数はデフォルト値(5)で設定されます.

  パラメータ:
    `user` - 対象のユーザ名を設定します.
    `passwd` - 対象のパスワード情報を設定します.
  例外:
    `InputException` - 入力例外.

### addUser

    public final void addUser(java.lang.String user,
                              java.lang.String passwd,
                              boolean rootOwner,
                              boolean rootGroup)
                       throws InputException

  ユーザ追加.
  ユーザ情報を追加します.
  また、最大接続数はデフォルト値(5)で設定されます.

  パラメータ:
    `user` - 対象のユーザ名を設定します.
    `passwd` - 対象のパスワード情報を設定します.
    `rootOwner` - 対象ユーザに対してルート権限を与えるか設定します.
    `rootGroup` - 対象ユーザに対してルートグループ権限を与えるか設定します.
  例外:
    `InputException` - 入力例外.

### addUser

    public final void addUser(java.lang.String user,
                              java.lang.String passwd,
                              boolean rootOwner,
                              boolean rootGroup,
                              int max,
                              java.lang.String[] extension)
                       throws InputException

  ユーザ追加.
  ユーザ情報を追加します.

  パラメータ:
    `user` - 対象のユーザ名を設定します.
    `passwd` - 対象のパスワード情報を設定します.
    `rootOwner` - 対象ユーザに対してルート権限を与えるか設定します.
    `rootGroup` - 対象ユーザに対してルートグループ権限を与えるか設定します.
    `max` - ユーザ同時接続数を設定します.
    設定可能な最大値は[512]です.
    また[0]とするか、最大値以上を設定した場合、同時ユーザ接続数の上限が無くなります.
    また[-1]を設定することで、このユーザを利用出来なくします.
    `extension` - 拡張情報を設定します.
  例外:
    `InputException` - 入力例外.

### removeUser

    public final void removeUser(java.lang.String user)
                          throws InputException

  ユーザ削除.
  対象のユーザ名を削除します.

  パラメータ:
    `user` - 削除対象のユーザ名を設定します.
  例外:
    `InputException` - 入力例外.

### renewPasswd

    public final void renewPasswd(java.lang.String user,
                                  java.lang.String newPasswd)
                           throws InputException

  対象ユーザに対するパスワード変更.
  対象のユーザ情報のパスワードを変更します.

  パラメータ:
    `user` - 変更対象のユーザ名を設定します.
    `newPasswd` - 変更対象のパスワード名を設定します.
  例外:
    `InputException` - 入力例外.

### renewRootOwner

    public final void renewRootOwner(java.lang.String user,
                                     boolean owner)
                              throws InputException

  対象ユーザに対するROOT権限を変更.
  対象のユーザ情報のROOT権限を変更します.

  パラメータ:
    `user` - 変更対象のユーザ名を設定します.
    `owner` - 対象ユーザに対してルート権限を与えるか設定します.
  例外:
    `InputException` - 入力例外.

### renewRootGroup

    public final void renewRootGroup(java.lang.String user,
                                     boolean group)
                              throws InputException

  対象ユーザに対するROOTグループを変更.
  対象のユーザ情報のROOTグループを変更します.

  パラメータ:
    `user` - 変更対象のユーザ名を設定します.
    `group` - 対象ユーザに対してルートグループを与えるか設定します.
  例外:
    `InputException` - 入力例外.

### renewMaxUserCount

    public final void renewMaxUserCount(java.lang.String user,
                                        int newMax)
                                 throws InputException

  対象ユーザに対する最大接続数を変更.
  対象のユーザ情報の最大接続数を変更します.

  パラメータ:
    `user` - 変更対象のユーザ名を設定します.
    `newMax` - 変更対象の最大接続数を設定します.
  例外:
    `InputException` - 入力例外.

### renewExtension

    public final void renewExtension(java.lang.String user,
                                     java.lang.String[] newExtension)
                              throws InputException

  対象ユーザに対する拡張情報を変更.
  対象のユーザ情報の拡張情報を変更します.

  パラメータ:
    `user` - 変更対象のユーザ名を設定します.
    `newExtension` - 変更対象の拡張情報を設定します.
  例外:
    `InputException` - 入力例外.

### addUserCount

    public final void addUserCount(java.lang.String user)
                            throws InputException,
                                   LoginException

  対象ユーザのログインカウントを１インクリメント.
  対象ユーザのログインカウントを１インクリメントします.

  パラメータ:
    `user` - 対象のユーザ名を設定します.
  例外:
    `InputException` - 入力例外.
    `LoginException` - ログイン例外.

### removeUserCount

    public final void removeUserCount(java.lang.String user)
                               throws InputException

  対象ユーザのログインカウントを１デクリメント.
  対象ユーザのログインカウントを１デクリメントします.

  パラメータ:
    `user` - 対象のユーザ名を設定します.
  例外:
    `InputException` - 入力例外.

### getPasswd

    public final java.lang.String getPasswd(java.lang.String user)
                                     throws InputException

  対象ユーザに対するパスワード取得.
  対象のユーザ名に対するパスワードを取得します.

  パラメータ:
    `user` - 対象のユーザ名を設定します.
  戻り値:
    String 対象のパスワードが返されます.
  例外:
    `InputException` - 入力例外.

### getRootOwner

    public final boolean getRootOwner(java.lang.String user)
                               throws InputException

  対象ユーザに対するルート権限を取得.
  対象のユーザ名に対するルート権限を取得します.

  パラメータ:
    `user` - 対象のユーザ名を設定します.
  戻り値:
    boolean 対象のルート権限が返されます.
    [true]が返された場合、有効です.
    [false]が返された場合、無効です.
  例外:
    `InputException` - 入力例外.

### getRootGroupOwner

    public final boolean getRootGroupOwner(java.lang.String user)
                                    throws InputException

  対象ユーザに対するルートグループ権限を取得.
  対象のユーザ名に対するルートグループ権限を取得します.

  パラメータ:
    `user` - 対象のユーザ名を設定します.
  戻り値:
    boolean 対象のルートグループ権限が返されます.
    [true]が返された場合、有効です.
    [false]が返された場合、無効です.
  例外:
    `InputException` - 入力例外.

### getNowUserCount

    public final int getNowUserCount(java.lang.String user)
                              throws InputException

  対象ユーザに対する現在の接続数を取得.
  対象のユーザ名に対する現在の接続数を取得します.

  パラメータ:
    `user` - 対象のユーザ名を設定します.
  戻り値:
    int 現在の接続数が返されます.
  例外:
    `InputException` - 入力例外.

### getMaxUserCount

    public final int getMaxUserCount(java.lang.String user)
                              throws InputException

  対象ユーザに対する最大接続数を取得.
  対象のユーザ名に対する最大接続数を取得します.

  パラメータ:
    `user` - 対象のユーザ名を設定します.
  戻り値:
    int 対象の最大接続数が返されます.
    [-1]が返された場合、ログイン出来ません. [0]が返された場合、無制限にログイン出来ます.
  例外:
    `InputException` - 入力例外.

### getExtension

    public final java.lang.String[] getExtension(java.lang.String user)
                                          throws InputException

  対象ユーザに対する拡張情報を取得.
  対象のユーザ名に対する拡張情報を取得します.

  パラメータ:
    `user` - 対象のユーザ名を設定します.
  戻り値:
    String[] 対象の拡張情報が返されます.
  例外:
    `InputException` - 入力例外.

### getUserNameByUserID

    public final int getUserNameByUserID(java.lang.String user)

  ユーザ名に対するユーザIDを取得.
  対象のユーザに対するユーザIDを取得します.

  パラメータ:
    `user` - 対象のユーザ名を設定します.
  戻り値:
    int 対象のユーザIDが返されます.
    [IdManager.NOT_ID]が返された場合、対象のユーザ名は 存在しません

### getUserIDByUserName

    public final java.lang.String getUserIDByUserName(int id)

  ユーザIDに対するユーザ名を取得.
  対象のユーザIDに対するユーザ名を取得します.

  パラメータ:
    `id` - 対象のユーザIDを設定します.
  戻り値:
    String 対象のユーザ名が返されます.

### getUsers

    public final java.lang.String[] getUsers()

  ユーザ名一覧を取得.
  管理ユーザ名一覧を取得します.

  戻り値:
    String[] 管理されているユーザ名一覧が返されます.

### getUserLength

    public final int getUserLength()

  ユーザ名数を取得.
  管理ユーザ名数を取得します.

  戻り値:
    int 管理されているユーザ名数を取得します.

### isUserPasswd

    public final boolean isUserPasswd(java.lang.String user,
                                      java.lang.String passwd)

  対象ユーザ名のパスワードが正しいかチェック.
  対象ユーザ名のパスワードが正しいかチェックします.

  パラメータ:
    `user` - 対象のユーザ名を設定します.
    `passwd` - 対象のパスワード情報を設定します.
  戻り値:
    boolean チェック結果が返されます.
    [true]が返された場合、対象条件は正しいです.
    [false]が返された場合、対象条件は正しくありません.

### isUser

    public final boolean isUser(java.lang.String user)

  ユーザ存在チェック.
  対象ユーザ名が存在するかチェックします.

  パラメータ:
    `user` - チェック対象のユーザ名を設定します.
  戻り値:
    boolean チェック結果が返されます.
    [true]が返された場合対象ユーザ名は存在します.
    [false]が返された場合対象ユーザ名は存在しません.

### isUseUser

    public final boolean isUseUser(java.lang.String user)

  利用可能ユーザチェック.
  利用可能なユーザチェックを行います.

  パラメータ:
    `user` - チェック対象のユーザ名を設定します.
  戻り値:
    boolean チェック結果が返されます.
    [true]が返された場合対象ユーザ名は存在します.
    [false]が返された場合対象ユーザ名は存在しません.

概要 | パッケージ | クラス | 使用 | 階層ツリー | 非推奨 API | 索引
前のクラス 次のクラス | フレームあり フレームなし
概要: 入れ子 | フィールド | コンストラクタ | メソッド | 詳細: フィールド | コンストラクタ | メソッド