public class NbUser
extends java.lang.Object
本クラスのインスタンスはスレッドセーフではない。
修飾子とタイプ | クラスと説明 |
---|---|
static class |
NbUser.LoginParam
ログインパラメータ。
|
static class |
NbUser.Query
ユーザクエリ条件。
|
コンストラクタと説明 |
---|
NbUser()
デフォルトコンストラクタ (マルチテナント非対応)
|
NbUser(NbService service)
コンストラクタ (マルチテナント対応)
|
修飾子とタイプ | メソッドと説明 |
---|---|
static void |
__resetNebulaService() |
NbService |
_getService() |
void |
delete(NbResultCallback callback)
ユーザの削除を行う。
|
static NbUser.LoginParam |
extractOneTimeTokenFromUri(java.lang.String uriString)
リダイレクト URI からワンタイムトークンを取り出す
|
java.lang.String |
getCreatedTime()
ユーザ情報作成時間を取得する。
|
static NbUser |
getCurrentUser()
現在ログインしているユーザの情報を取得する(キャッシュから読み出す)。
|
static NbUser |
getCurrentUser(NbService service)
現在ログインしているユーザの情報を取得する(キャッシュから読み出す)。
|
java.lang.String |
getEmail()
E-mailを取得する。
|
java.util.List<java.lang.String> |
getGroups()
ユーザが所属するグループ一覧を取得する
|
NbJSONObject |
getOptions()
オプション情報を取得する。
|
static java.lang.String |
getSessionToken()
セッショントークンを取得する。
|
static java.lang.String |
getSessionToken(NbService service)
セッショントークンを取得する。
|
static long |
getSessionTokenExpiration()
ログインの有効期限を取得する。
|
static long |
getSessionTokenExpiration(NbService service)
ログインの有効期限を取得する。
|
java.lang.String |
getUpdatedTime()
ユーザ情報更新時間を取得する。
|
static void |
getUser(NbService service,
java.lang.String userId,
NbCallback<NbUser> callback)
ユーザ情報の取得を行う(マルチテナント対応)
ユーザ情報の取得はUSERSバケットおよび対象ユーザに対するread権限が必要となる。
|
static void |
getUser(NbService service,
java.lang.String userId,
NbUsersCallback callback)
非推奨です。
|
static void |
getUser(java.lang.String userId,
NbCallback<NbUser> callback)
ユーザ情報の取得を行う。
|
static void |
getUser(java.lang.String userId,
NbUsersCallback callback)
非推奨です。
|
java.lang.String |
getUserId()
ユーザIDを取得する。
|
java.lang.String |
getUserName()
ユーザ名を取得する。
|
static boolean |
isLoggedIn()
ログイン状態の確認を行う (マルチテナント非対応)
クライアント証明書認証使用時は使用しないこと。
|
static boolean |
isLoggedIn(NbService service)
ログイン状態の確認を行う (マルチテナント対応)
クライアント証明書認証使用時は使用しないこと。
|
static void |
login(NbService service,
NbUser.LoginParam param,
NbCallback<NbUser> callback)
BaaSサーバへログインを行う (マルチテナント対応)。
|
static void |
login(NbService service,
java.lang.String username,
java.lang.String email,
java.lang.String password,
NbCallback<NbUser> callback)
非推奨です。
|
static void |
login(NbService service,
java.lang.String username,
java.lang.String email,
java.lang.String password,
NbUsersCallback callback)
非推奨です。
|
static void |
login(NbUser.LoginParam param,
NbCallback<NbUser> callback)
BaaSサーバへログインを行う。
|
static void |
login(java.lang.String username,
java.lang.String email,
java.lang.String password,
NbCallback<NbUser> callback)
非推奨です。
|
static void |
login(java.lang.String username,
java.lang.String email,
java.lang.String password,
NbUsersCallback callback)
|
static void |
loginWithEmail(NbService service,
java.lang.String email,
java.lang.String password,
NbCallback<NbUser> callback)
E-mailを指定してBaaSサーバへログインを行う。
|
static void |
loginWithEmail(java.lang.String email,
java.lang.String password,
NbCallback<NbUser> callback)
E-mailを指定してBaaSサーバへログインを行う。
|
static void |
loginWithUsername(NbService service,
java.lang.String username,
java.lang.String password,
NbCallback<NbUser> callback)
ユーザ名を指定してBaaSサーバへログインを行う。
|
static void |
loginWithUsername(java.lang.String username,
java.lang.String password,
NbCallback<NbUser> callback)
ユーザ名を指定してBaaSサーバへログインを行う。
|
static void |
logout(NbCallback<NbUser> callback)
ログアウトを行う。
|
static void |
logout(NbService service,
NbCallback<NbUser> callback)
ログアウトを行う (マルチテナント対応)
セッショントークンを破棄し、ログイン状態を解除する。
|
static void |
logout(NbService service,
NbUsersCallback callback)
非推奨です。
|
static void |
logout(NbUsersCallback callback)
非推奨です。
logout(NbCallback) で置き換え |
static void |
query(NbService service,
NbUser.Query query,
NbCallback<java.util.List<NbUser>> callback)
ユーザ情報の検索を行う(マルチテナント対応)
実行にはUSERSバケットおよび対象ユーザに対するread権限が必要となる。
|
static void |
query(NbService service,
NbUser.Query query,
NbUsersCountCallback callback)
非推奨です。
|
static void |
query(NbService service,
java.lang.String username,
java.lang.String email,
NbCallback<java.util.List<NbUser>> callback)
非推奨です。
|
static void |
query(NbUser.Query query,
NbCallback<java.util.List<NbUser>> callback)
ユーザ情報の検索を行う(マルチテナント非対応)
実行にはUSERSバケットおよび対象ユーザに対するread権限が必要となる。
|
static void |
query(NbUser.Query query,
NbUsersCountCallback callback)
非推奨です。
|
static void |
query(java.lang.String username,
java.lang.String email,
NbCallback<java.util.List<NbUser>> callback)
非推奨です。
query(Query, NbCallback) で置き換え |
static void |
queryWithCount(NbService service,
NbUser.Query query,
NbCountCallback<java.util.List<NbUser>> callback)
ユーザ情報の検索を行う(件数取得付き)(マルチテナント対応)
実行にはUSERSバケットおよび対象ユーザに対するread権限が必要となる。
|
static void |
queryWithCount(NbUser.Query query,
NbCountCallback<java.util.List<NbUser>> callback)
ユーザ情報の検索を行う(件数取得付き)(マルチテナント非対応)
実行にはUSERSバケットおよび対象ユーザに対するread権限が必要となる。
|
static void |
refreshCurrentUser(NbCallback<NbUser> callback)
現在ログインしているユーザの情報を取得する。
|
static void |
refreshCurrentUser(NbService service,
NbCallback<NbUser> callback)
現在ログインしているユーザの情報を取得する。
|
static void |
refreshCurrentUser(NbService service,
NbUsersCallback callback)
非推奨です。
|
static void |
refreshCurrentUser(NbUsersCallback callback)
非推奨です。
|
void |
register(java.lang.String password,
NbCallback<NbUser> callback)
設定されたユーザ名、E-mail、パスワードを使用しユーザの登録を行う。
|
void |
register(java.lang.String password,
NbUsersCallback callback)
非推奨です。
|
static void |
resetPassword(NbService service,
java.lang.String username,
java.lang.String email,
NbResultCallback callback)
パスワードのリセット要求を行う(マルチテナント対応)
実行にはユーザ名もしくはE-mailどちらかを必ず指定する必要がある。
|
static void |
resetPassword(java.lang.String username,
java.lang.String email,
NbResultCallback callback)
パスワードのリセット要求を行う(マルチテナント非対応)
実行にはユーザ名もしくはE-mailどちらかを必ず指定する必要がある。
|
void |
save(java.lang.String password,
NbCallback<NbUser> callback)
ユーザ情報の保存を行う。
|
void |
save(java.lang.String password,
NbUsersCallback callback)
非推奨です。
save(String, NbCallback) で置き換え。 |
NbUser |
setEmail(java.lang.String email)
E-mailアドレスを設定する。
|
NbUser |
setOptions(NbJSONObject options)
オプション情報を設定する。
|
NbUser |
setUserName(java.lang.String userName)
ユーザ名を設定する。
|
NbJSONObject |
toJsonObject()
NbUser を ユーザの JSON 表現に変換する。
|
public NbUser()
public NbUser(NbService service)
service
- サービスpublic NbService _getService()
@Deprecated public static void login(java.lang.String username, java.lang.String email, java.lang.String password, NbUsersCallback callback)
loginWithUsername(String, String, NbCallback)
, loginWithEmail(String, String, NbCallback)
,
login(LoginParam, NbCallback)
, login(NbService, LoginParam, NbCallback)
で置き換えusername
- ログインするユーザのユーザ名 (username/emailどちらか一方を指定)email
- ログインするユーザのEmail (username/emailどちらか一方を指定)password
- ログインするユーザのパスワードcallback
- ログインしたユーザを受け取るコールバック@Deprecated public static void login(java.lang.String username, java.lang.String email, java.lang.String password, NbCallback<NbUser> callback)
public static void loginWithUsername(java.lang.String username, java.lang.String password, NbCallback<NbUser> callback)
ログイン動作の詳細は login(NbService, LoginParam, NbCallback)
を参照。
クライアント証明書認証使用時は使用しないこと。
username
- ログインするユーザのユーザ名password
- ログインするユーザのパスワードcallback
- ログインしたユーザを受け取るコールバックpublic static void loginWithUsername(NbService service, java.lang.String username, java.lang.String password, NbCallback<NbUser> callback)
ログイン動作の詳細は login(NbService, LoginParam, NbCallback)
を参照。
クライアント証明書認証使用時は使用しないこと。
service
- NbServiceusername
- ログインするユーザのユーザ名password
- ログインするユーザのパスワードcallback
- ログインしたユーザを受け取るコールバックpublic static void loginWithEmail(java.lang.String email, java.lang.String password, NbCallback<NbUser> callback)
ログイン動作の詳細は login(NbService, LoginParam, NbCallback)
を参照。
クライアント証明書認証使用時は使用しないこと。
email
- ログインするユーザのEmailpassword
- ログインするユーザのパスワードcallback
- ログインしたユーザを受け取るコールバックpublic static void loginWithEmail(NbService service, java.lang.String email, java.lang.String password, NbCallback<NbUser> callback)
ログイン動作の詳細は login(NbService, LoginParam, NbCallback)
を参照。
クライアント証明書認証使用時は使用しないこと。
service
- NbServiceemail
- ログインするユーザのEmailpassword
- ログインするユーザのパスワードcallback
- ログインしたユーザを受け取るコールバックpublic static void login(NbUser.LoginParam param, NbCallback<NbUser> callback)
ログイン動作の詳細は login(NbService, LoginParam, NbCallback)
を参照。
クライアント証明書認証使用時は使用しないこと。
param
- ログインパラメータ。username, email, token いずれか必須。callback
- ログインしたユーザを受け取るコールバック@Deprecated public static void login(NbService service, java.lang.String username, java.lang.String email, java.lang.String password, NbUsersCallback callback)
login(NbService, LoginParam, NbCallback)
で置き換えクライアント証明書認証使用時は使用しないこと。
@Deprecated public static void login(NbService service, java.lang.String username, java.lang.String email, java.lang.String password, NbCallback<NbUser> callback)
public static void login(NbService service, NbUser.LoginParam param, NbCallback<NbUser> callback)
ID/パスワードを使用してログインする場合は、param には username, email のいずれかと password を指定すること。 認証連携によるワンタイムトークンログインを行う場合は、param には token のみを指定すること。
ログインに成功した場合はログアウトするか、 セッショントークンの有効期限を迎えるまでログイン状態が維持される。
オフライン時はログインキャッシュを使用する。ログインキャッシュが ローカルDBに存在しない場合はログイン不可となる。 オフライン時もログアウトするか、ログインキャッシュの有効期限を 迎えるまでログイン状態が維持される。
オフライン時にログインし、その後オンライン状態に遷移した場合、 ログインキャッシュは使わずセッショントークンを使用する。 セッショントークンが利用不可であれば、オンラインでAPIを実行した際に 認証エラーとなる。その際は再ログインが必要。
ワンタイムトークンを使用したログインは、オフライン時には使用できない。 クライアント証明書認証使用時は使用しないこと。
service
- NbServiceparam
- ログインパラメータ。username, email, token いずれか必須。callback
- ログインしたユーザを受け取るコールバック@Deprecated public static void logout(NbUsersCallback callback)
logout(NbCallback)
で置き換えクライアント証明書認証使用時は使用しないこと。
public static void logout(NbCallback<NbUser> callback)
callback
- 実行結果を受け取るコールバックNbUsersCallback
@Deprecated public static void logout(NbService service, NbUsersCallback callback)
logout(NbService, NbCallback)
で置き換えpublic static void logout(NbService service, NbCallback<NbUser> callback)
service
- NbServicecallback
- 実行結果を受け取るコールバックNbUsersCallback
public static boolean isLoggedIn()
public static boolean isLoggedIn(NbService service)
service
- NbService@Deprecated public void register(java.lang.String password, NbUsersCallback callback)
register(String, NbCallback)
で置き換えpublic void register(java.lang.String password, NbCallback<NbUser> callback)
登録にはUSERSバケットに対する anonymousユーザのcreate権限が必要となる。
E-mail アドレスは事前に設定されていなければならない。 ユーザ名はオプションであるため、指定しなくても良い。
password
- 登録するユーザのパスワードcallback
- 実行結果を受け取るコールバックNbUsersCallback
,
setUserName(String)
,
setEmail(String)
@Deprecated public static void query(java.lang.String username, java.lang.String email, NbCallback<java.util.List<NbUser>> callback)
query(Query, NbCallback)
で置き換えusername
- 検索対象のユーザ名(オプション)email
- 検索対象のE-mail(オプション)callback
- 実行結果を受け取るコールバック@Deprecated public static void query(NbService service, java.lang.String username, java.lang.String email, NbCallback<java.util.List<NbUser>> callback)
query(NbService, Query, NbCallback)
で置き換えusername
- 検索対象のユーザ名(オプション)email
- 検索対象のE-mail(オプション)callback
- 実行結果を受け取るコールバックpublic static void query(NbUser.Query query, NbCallback<java.util.List<NbUser>> callback)
query
- クエリ条件 NbUser.Query
callback
- コールバック@Deprecated public static void query(NbUser.Query query, NbUsersCountCallback callback)
queryWithCount(Query, NbCountCallback)
で置き換えpublic static void queryWithCount(NbUser.Query query, NbCountCallback<java.util.List<NbUser>> callback)
query
- クエリ条件 NbUser.Query
callback
- コールバックpublic static void query(NbService service, NbUser.Query query, NbCallback<java.util.List<NbUser>> callback)
service
- NbServicequery
- クエリ条件 NbUser.Query
callback
- コールバック@Deprecated public static void query(NbService service, NbUser.Query query, NbUsersCountCallback callback)
queryWithCount(NbService, Query, NbCountCallback)
で置き換えpublic static void queryWithCount(NbService service, NbUser.Query query, NbCountCallback<java.util.List<NbUser>> callback)
service
- NbServicequery
- クエリ条件 NbUser.Query
callback
- コールバック@Deprecated public static void getUser(java.lang.String userId, NbUsersCallback callback)
getUser(String, NbCallback)
で置き換えpublic static void getUser(java.lang.String userId, NbCallback<NbUser> callback)
ユーザ情報の取得はUSERSバケットおよび対象ユーザに対するread権限が必要となる。
userId
- 検索対象のユーザIDcallback
- 実行結果を受け取るコールバック@Deprecated public static void getUser(NbService service, java.lang.String userId, NbUsersCallback callback)
getUser(NbService, String, NbCallback)
で置き換えpublic static void getUser(NbService service, java.lang.String userId, NbCallback<NbUser> callback)
ユーザ情報の取得はUSERSバケットおよび対象ユーザに対するread権限が必要となる。
service
- NbServiceuserId
- 検索対象のユーザIDcallback
- 実行結果を受け取るコールバック@Deprecated public static void refreshCurrentUser(NbUsersCallback callback)
refreshCurrentUser(NbCallback)
で置き換えクライアント証明書認証使用時は、オフラインでは動作しない。
public static void refreshCurrentUser(NbCallback<NbUser> callback)
callback
- 実行結果を受け取るコールバック@Deprecated public static void refreshCurrentUser(NbService service, NbUsersCallback callback)
refreshCurrentUser(NbService, NbCallback)
で置き換えクライアント証明書認証使用時は、オフラインでは動作しない。
public static void refreshCurrentUser(NbService service, NbCallback<NbUser> callback)
service
- NbServicecallback
- 実行結果を受け取るコールバックpublic static void resetPassword(java.lang.String username, java.lang.String email, NbResultCallback callback)
username
- リセット対象のユーザ名email
- リセット対象のE-mailcallback
- 実行結果を受け取るコールバックpublic static void resetPassword(NbService service, java.lang.String username, java.lang.String email, NbResultCallback callback)
username
- リセット対象のユーザ名email
- リセット対象のE-mailcallback
- 実行結果を受け取るコールバック@Deprecated public void save(java.lang.String password, NbUsersCallback callback)
save(String, NbCallback)
で置き換え。public void save(java.lang.String password, NbCallback<NbUser> callback)
本メソッドはログイン後のみ実行できる。
情報の変更は自ユーザのみ可能。 但し、マスターキーを使用した場合のみどのユーザの情報も変更可能である。
password
- 保存するユーザのパスワードcallback
- 保存したユーザを受け取るコールバックpublic void delete(NbResultCallback callback)
本メソッドはログイン後のみ実行できる。
ユーザの削除は自ユーザのみ可能。 但し、マスターキーを使用した場合どのユーザの情報も削除可能となる。
callback
- APIの実行結果を取得するコールバックpublic static void __resetNebulaService()
public NbUser setUserName(java.lang.String userName)
ユーザ名には以下の条件がある。ただし、規定外のユーザ名を設定しても ここではエラーにはならない。register や save のタイミングでエラーとなる。
userName
- 設定後のユーザ名。save(String, NbCallback)
,
register(String, NbCallback)
public java.lang.String getUserName()
public NbUser setEmail(java.lang.String email)
email
- 設定後のE-mail。save(String, NbCallback)
public java.lang.String getEmail()
public NbUser setOptions(NbJSONObject options)
options
- 設定後のオプション情報。save(String, NbCallback)
public NbJSONObject getOptions()
public java.util.List<java.lang.String> getGroups()
public java.lang.String getUserId()
public java.lang.String getCreatedTime()
public java.lang.String getUpdatedTime()
public static long getSessionTokenExpiration()
public static long getSessionTokenExpiration(NbService service)
public static java.lang.String getSessionToken()
public static java.lang.String getSessionToken(NbService service)
public static NbUser getCurrentUser()
public static NbUser getCurrentUser(NbService service)
public NbJSONObject toJsonObject()
public static NbUser.LoginParam extractOneTimeTokenFromUri(java.lang.String uriString) throws java.net.URISyntaxException
uriString
- URI文字列java.lang.IllegalArgumentException
- URI文字列にワンタイムトークンが含まれていないjava.net.URISyntaxException
- URI不正