com.fiverworks.xone.model
クラス XoneUser

java.lang.Object
  拡張com.fiverworks.xone.model.XoneUser
すべての実装インタフェース:
Comparable, Transformable

public class XoneUser
extends Object
implements Comparable, Transformable

Xoneのユーザを表すクラスです。


フィールドの概要
static String ADMIN_ROLE
          アドミニストレータのロール
static int PASSWORD_MIN_LENGTH
          パスワードの最短の長さ
static String USER_ROLE
          一般ユーザのロール
static String XONE_USER_CLASS
          ユーザを表すクラス名
 
コンストラクタの概要
XoneUser(String sessionId, int userId, String name, String nickName, String cipherdPassword, String role, String defaultGroup, String description)
          各パラメータからXoneUserのインスタンスを生成します(システムの内部で使用)。
XoneUser(String name, String nickName, char[] password, String role, String defaultGroup, String description)
          各パラメータからXoneUserのインスタンスを生成します(アプリケーションからはこのコンストラクタを使ってください)
パラメータのpasswordは平文(暗号化されていない文字列)で指定してください。
XoneUser(String name, String nickName, String cipherdPassword, String role, String defaultGroup, String description)
          各パラメータからXoneUserのインスタンスを生成します(システムの内部で使用)。
XoneUser(String sessionId, XoneUser xu)
          指定されたセッションIDとXoneObjectの内容からXoneUserのインスタンスを生成します(システムの内部で使用)。
XoneUser(XoneObject xo)
          指定されたXoneObjectの内容からXoneUserのインスタンスを生成します(システムの内部で使用)。
 
メソッドの概要
 void addGroup(String name)
          グループを追加します。
 void clearGroups()
          グループの内容をクリアします。
 int compareTo(Object o)
          指定されたオブジェクトと比較します。
 boolean containsGroup(String name)
          指定したグループが含まれるか調べます。
 String getDefaultGroup()
          デフォルトのグループ名を取得します。
 String getDescription()
          説明を取得します。
 Set getGroups()
          グループのセットを取得します。
 String getName()
          ユーザ名を取得します。
 String getNickName()
          ユーザのニックネームを取得します。
 String getPassword()
          暗号化されたパスワードを取得します。
 String getRole()
          ロールを取得します。
 String getSessionId()
          セッションIDを取得します。
 int getUserId()
          ユーザIDを取得します。
 Iterator groupIterator()
          グループのイテレータを取得します。
 int groupSize()
          グループのサイズを取得します。
 boolean isAdminRole()
          このユーザのロールがアドミニストレータかどうかか調べます。
static boolean isLegalRole(String role)
          指定されたロールが正しいかどうか調べます。
 boolean isUserRole()
          このユーザのロールが一般ユーザかどうかか調べます。
 void removeGroup(String name)
          グループを削除します。
 void set(XoneObject xo)
          XoneUserは不変オブジェクトなので、このメソッドを呼び出すとXoneRuntimeExceptionが投げられます。
 String toFullString()
          文字列表現を返します。
 String toString()
          文字列表現を返します。
 XoneObject toXoneObject()
          XoneObjectに変換します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

フィールドの詳細

PASSWORD_MIN_LENGTH

public static final int PASSWORD_MIN_LENGTH
パスワードの最短の長さ

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

ADMIN_ROLE

public static final String ADMIN_ROLE
アドミニストレータのロール

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

USER_ROLE

public static final String USER_ROLE
一般ユーザのロール

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

XONE_USER_CLASS

public static final String XONE_USER_CLASS
ユーザを表すクラス名

関連項目:
定数フィールド値
コンストラクタの詳細

XoneUser

public XoneUser(String sessionId,
                int userId,
                String name,
                String nickName,
                String cipherdPassword,
                String role,
                String defaultGroup,
                String description)
各パラメータからXoneUserのインスタンスを生成します(システムの内部で使用)。

パラメータ:
sessionId -
userId -
name -
nickName -
cipherdPassword -
role -
defaultGroup -
description -

XoneUser

public XoneUser(String name,
                String nickName,
                String cipherdPassword,
                String role,
                String defaultGroup,
                String description)
各パラメータからXoneUserのインスタンスを生成します(システムの内部で使用)。

パラメータ:
name -
nickName -
cipherdPassword -
role -
defaultGroup -
description -

XoneUser

public XoneUser(String name,
                String nickName,
                char[] password,
                String role,
                String defaultGroup,
                String description)
各パラメータからXoneUserのインスタンスを生成します(アプリケーションからはこのコンストラクタを使ってください)
パラメータのpasswordは平文(暗号化されていない文字列)で指定してください。内部で暗号化されるので、平文では保持されません。

パラメータ:
name - ユーザ名
nickName - ニックネーム
password - パスワード(暗号化されていないパスワード)。PASSWORD_MIN_LENGTH以上の長さで指定してください。
role - ロール(ADMIN_ROLE,USER_ROLEのいずれか)
defaultGroup - デフォルトのグループ
description - 説明
例外:
XoneRuntimeException - name,defaultGroupがnullまたは空白の場合、あるいはpasswordやroleが不正な場合

XoneUser

public XoneUser(String sessionId,
                XoneUser xu)
指定されたセッションIDとXoneObjectの内容からXoneUserのインスタンスを生成します(システムの内部で使用)。

パラメータ:
sessionId -
xu -

XoneUser

public XoneUser(XoneObject xo)
指定されたXoneObjectの内容からXoneUserのインスタンスを生成します(システムの内部で使用)。

パラメータ:
xo - XoneObject
メソッドの詳細

toXoneObject

public XoneObject toXoneObject()
XoneObjectに変換します。

定義:
インタフェース Transformable 内の toXoneObject
戻り値:
変換したXoneObject

addGroup

public void addGroup(String name)
グループを追加します。グループ名がnullだったり、デフォルトのグループ名と同じ場合は追加されません。

パラメータ:
name - 追加するグループ名

clearGroups

public void clearGroups()
グループの内容をクリアします。


containsGroup

public boolean containsGroup(String name)
指定したグループが含まれるか調べます。

パラメータ:
name - 調べるグループ名
戻り値:
含まれていればtrue

removeGroup

public void removeGroup(String name)
グループを削除します。

パラメータ:
name - 削除するグループ名

groupIterator

public Iterator groupIterator()
グループのイテレータを取得します。

戻り値:
グループのイテレータ

groupSize

public int groupSize()
グループのサイズを取得します。

戻り値:
グループのサイズ

getDefaultGroup

public String getDefaultGroup()
デフォルトのグループ名を取得します。

戻り値:
グループ名

getDescription

public String getDescription()
説明を取得します。

戻り値:
説明

getGroups

public Set getGroups()
グループのセットを取得します。

戻り値:
グループのセット

getName

public String getName()
ユーザ名を取得します。

戻り値:
ユーザ名

getNickName

public String getNickName()
ユーザのニックネームを取得します。

戻り値:
ニックネーム

getPassword

public String getPassword()
暗号化されたパスワードを取得します。

戻り値:
暗号化されたパスワード

getRole

public String getRole()
ロールを取得します。

戻り値:
ロール(ADMIN_ROLE、USER_ROLEのいずれか)

getSessionId

public String getSessionId()
セッションIDを取得します。

戻り値:
セッションID

getUserId

public int getUserId()
ユーザIDを取得します。

戻り値:
ユーザID

set

public void set(XoneObject xo)
XoneUserは不変オブジェクトなので、このメソッドを呼び出すとXoneRuntimeExceptionが投げられます。

定義:
インタフェース Transformable 内の set
パラメータ:
xo - XoneObject
例外:
XoneRuntimeException

compareTo

public int compareTo(Object o)
指定されたオブジェクトと比較します。

定義:
インタフェース Comparable 内の compareTo
パラメータ:
o - 比較するオブジェクト
戻り値:
パラメータのユーザ名がこのユーザ名に等しい場合は0。パラメータのユーザ名がこのユーザ名より辞書順で小さければ0より小さい値。パラメータのユーザ名がこのユーザ名より辞書順で大きい場合は0より大きい値

toString

public String toString()
文字列表現を返します。

戻り値:
文字列

isAdminRole

public boolean isAdminRole()
このユーザのロールがアドミニストレータかどうかか調べます。

戻り値:
アドミニストレータのときはtrue

isUserRole

public boolean isUserRole()
このユーザのロールが一般ユーザかどうかか調べます。

戻り値:
一般ユーザのときはtrue

toFullString

public String toFullString()
文字列表現を返します。

戻り値:
文字列

isLegalRole

public static boolean isLegalRole(String role)
指定されたロールが正しいかどうか調べます。

パラメータ:
role - 調べるロール
戻り値:
roleがADMIN_ROLE、USER_ROLEのいずれかならばtrue