com.nec.baas.core

クラス NbService

java.lang.Object

com.nec.baas.core.NbService

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

NbServiceOffline

public abstract class NbService
extends java.lang.Object
implements NbServiceOffline

MBaaS 機能を提供するメインクラス。

NbServiceBuilder.build()でインスタンスを生成する。 マルチテナントモードに設定しない限り、アプリケーションは本インスタンスをシングルトンとして扱うべきである。

導入されたバージョン:

1.0

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
NbService()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
abstract NbRestExecutor	createRestExecutor() REST Executor を生成する
static void	disableClientCertificate() クライアント証明書認証を無効にする 証明書未登録の状態でコールした場合、何も行わない。
static void	enableMultiTenant(boolean enabled) マルチテナントモードの有効設定を行う。
abstract NbFileBucketManager	fileBucketManager() NbFileBucketManagerを取得する。
abstract void	finish() NebulaServiceの終了。
abstract NbHttpRequestFactory	getHttpRequestFactory() HTTP リクエストファクトリを取得する
static NbService	getInstance() シングルトンインスタンスを取得する。
static boolean	isClientCertSet() クライアント証明書の設定状況を確認する。
abstract NbObjectBucketManager	objectBucketManager() NbObjectBucketManagerを取得する。
abstract void	setAppId(java.lang.String appId) アプリケーションIDを設定する(NbService生成後に変更する場合に使用する)。
abstract void	setAppKey(java.lang.String appKey) アプリケーションキーを設定する(NbService生成後に変更する場合に使用する)。
static void	setClientCertificate(java.io.InputStream clientCert, java.lang.String password, java.io.InputStream trustedCaCert) クライアント証明書認証に使用する証明書を登録する 本設定後、サーバが対応する場合にクライアント証明書による認証が可能となる。
abstract void	setEndPointUri(java.lang.String endPointUri) エンドポイントURIを設定する(NbService生成後に変更する場合に使用する)。
static void	setProxy(java.lang.String host, int port) REST API 呼び出しにおける HTTP プロキシサーバを設定する。
abstract void	setTenantId(java.lang.String tenantId) テナントIDを設定する(NbService生成後に変更する場合に使用する)。

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

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

インタフェースから継承されたメソッド com.nec.baas.core.NbServiceOffline

changeDatabasePassword, getLoginCacheValidTime, registerNetworkEventListener, setLoginCacheValidTime, unregisterNetworkEventListener

コンストラクタの詳細

NbService

public NbService()

メソッドの詳細

getInstance

public static NbService getInstance()

シングルトンインスタンスを取得する。 インスタンスは事前に NbServiceBuilder を使用して作成しておく必要がある。

戻り値:

NbService インスタンス

例外:

java.lang.IllegalStateException - インスタンスが作成されていない

enableMultiTenant

public static void enableMultiTenant(boolean enabled)

マルチテナントモードの有効設定を行う。

マルチテナント有効時は、シングルトンインスタンス取得時に IllegalStateException がスローされる。 マルチテナント非対応API発行時も同様。

マルチテナント無効に明示的に設定した場合、NbService のインスタンスは厳密に１つしか作成されない。 (Strict Singleton モード。複数作成すると例外がスローされる)。

なお、マルチテナントモードを使用することができるのは NbGenericServiceBuilder だけである。 NbAndroidServiceBuilder では使用不可。

パラメータ:

enabled - 有効

setProxy

public static void setProxy(java.lang.String host,
                            int port)

REST API 呼び出しにおける HTTP プロキシサーバを設定する。

本設定後、すべての REST API 呼び出しは指定したプロキシサーバを使用する。 なお、本設定は全 NbService で共通である。

パラメータ:

host - プロキシホスト名。null に指定した場合はプロキシサーバを解除する。

port - プロキシポート番号

導入されたバージョン:

6.5.0

setClientCertificate

public static void setClientCertificate(java.io.InputStream clientCert,
                                        java.lang.String password,
                                        java.io.InputStream trustedCaCert)
                                 throws java.io.IOException,
                                        java.security.GeneralSecurityException

クライアント証明書認証に使用する証明書を登録する

本設定後、サーバが対応する場合にクライアント証明書による認証が可能となる。 本設定は全 NbService で共通である。 NbHttpClient#setAllowSelfSignedCertificate(boolean)がtrueの場合、本設定は無効となる。

パラメータ:

clientCert - クライアント証明書(.p12形式: 秘密鍵+クライアント証明書)

password - クライアント証明書のインポート用パスワード パスワード未設定の場合は""(空文字)を指定する。nullの場合は空文字とみなす

trustedCaCert - 信頼するCAの証明書(.pem形式)。通常PrivateCAの証明書を指定する。 "-----BEGIN CERTIFICATE-----","-----END CERTIFICATE-----" で囲まれた部分を証明書として使用する。 nullを設定した場合、システムデフォルトのTrustManagerを使用する。

例外:

java.io.IOException - 証明書が存在しない、証明書データが取得できない

java.security.GeneralSecurityException - 証明書の検証に問題が発生した

java.lang.IllegalArgumentException - クライアント証明書、CA証明書がどちらも指定されなかった

導入されたバージョン:

6.5.0

disableClientCertificate

public static void disableClientCertificate()

クライアント証明書認証を無効にする

証明書未登録の状態でコールした場合、何も行わない。 本設定は全 NbService で共通である。

導入されたバージョン:

6.5.0

isClientCertSet

public static boolean isClientCertSet()

クライアント証明書の設定状況を確認する。

戻り値:

クライアント証明書の設定状況

導入されたバージョン:

6.5.0

objectBucketManager

public abstract NbObjectBucketManager objectBucketManager()

NbObjectBucketManagerを取得する。 オブジェクトストレージの機能を利用する際に使用する。

戻り値:

オブジェクトバケットの管理を行うためのオブジェクト。

関連項目:

NbObjectBucketManagerImpl

fileBucketManager

public abstract NbFileBucketManager fileBucketManager()

NbFileBucketManagerを取得する。 ファイルストレージの機能を利用する際に使用する。

戻り値:

ファイルバケットの管理を行うためのオブジェクト。

関連項目:

NbFileBucketManager

finish

public abstract void finish()

NebulaServiceの終了。 MBaaS機能の利用が完了した際に使用する。 サービスの終了処理を行う。

setTenantId

public abstract void setTenantId(java.lang.String tenantId)

テナントIDを設定する(NbService生成後に変更する場合に使用する)。 本APIはFileStorage系クラスでは正しく動作しない。

パラメータ:

tenantId - テナントID

setAppId

public abstract void setAppId(java.lang.String appId)

アプリケーションIDを設定する(NbService生成後に変更する場合に使用する)。 本APIはFileStorage系クラスでは正しく動作しない。

パラメータ:

appId - アプリケーションID

setAppKey

public abstract void setAppKey(java.lang.String appKey)

アプリケーションキーを設定する(NbService生成後に変更する場合に使用する)。 本APIはFileStorage系クラスでは正しく動作しない。

パラメータ:

appKey - アプリケーションキー

setEndPointUri

public abstract void setEndPointUri(java.lang.String endPointUri)

エンドポイントURIを設定する(NbService生成後に変更する場合に使用する)。 本APIはFileStorage系クラスでは正しく動作しない。

パラメータ:

endPointUri - エンドポイントURI

getHttpRequestFactory

public abstract NbHttpRequestFactory getHttpRequestFactory()

HTTP リクエストファクトリを取得する

戻り値:

NbHttpRequestFactory

導入されたバージョン:

6.5.0

createRestExecutor

public abstract NbRestExecutor createRestExecutor()

REST Executor を生成する

戻り値:

NbRestExecutor

導入されたバージョン:

6.5.0