org.iplass.mtp.impl.pushnotification.fcmv1

クラス PushNotificationService

java.lang.Object

org.iplass.mtp.impl.pushnotification.PushNotificationService

org.iplass.mtp.impl.pushnotification.fcmv1.PushNotificationService

public class PushNotificationService
extends org.iplass.mtp.impl.pushnotification.PushNotificationService

Firebase Cloud Messaging (FCM) V1 API 通知サービス

FCM V1 API を利用した Push 通知を実現する機能です。 FCM については、FCM サービス概要 を確認すること。

Push通知を行う際の PushNotification は次のように設定されることを想定している。

1. org.iplass.mtp.pushnotification.PushNotification#setMessage(Map) に メッセージリソースの仕様 の通りに情報を設定する。宛先を含める。
2. org.iplass.mtp.pushnotification.PushNotification#setMessage(Map) に メッセージリソースの仕様 の通りに情報が設定する。
   宛先を含まない場合、org.iplass.mtp.pushnotification.PushNotification#addTo(String) で必要な宛先情報を追加する。
   宛先には、宛先タイプを意味するプレフィックスを指定する必要がある。プレフィックスは PushNotificationTargetType.getPrefixedValue(String) を利用して付与する。
3. org.iplass.mtp.pushnotification.PushNotification#setMessage(Map) を利用しない場合、その他のメソッドに通知に関する情報を設定する。
   その際、org.iplass.mtp.pushnotification.PushNotification#addTo(String) で必要な宛先情報を追加する。
   宛先には、宛先タイプを意味するプレフィックスを指定する必要がある。プレフィックスは PushNotificationTargetType.getPrefixedValue(String) を利用して付与する。

• FCM サービス概要
• FCM 送信 API仕様
• メッセージリソースの仕様
• エラーコードの仕様
• FcmError 仕様
• ApnsError 仕様

関連項目:

PushNotificationResultDetailKey

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	destroy()
protected PushNotificationResponseDetail	handleResponse(PushNotificationTarget target, int code, java.lang.String response, long retryAfterSeconds) 実行結果をハンドリングする 外部サービスの実行結果を受け、通知の結果を生成する。
void	init(Config config)
protected void	postProcessOfReequestPushApi(PushNotificationResponseDetail responseDetail) 通知APIリクエスト後処理 API の結果によって実行する処理を定義する。
protected PushNotificationResult	pushImpl(Tenant tenant, PushNotification notification)
protected PushNotificationResponseDetail	requestPushApi(PushNotificationTarget target, java.util.Map<java.lang.String,java.lang.Object> messageResource) FCM V1 API リクエストを行う FCM 送信 API仕様 に沿ったリクエストを行う。
protected PushNotificationResponseDetail	requestPushApiExponentialBackoff(PushNotificationTarget target, java.util.Map<java.lang.String,java.lang.Object> messageResource) 指数バックオフリトライを考慮した、FCM V1 API リクエストを行う リトライ可能なエラーの場合は、レスポンスヘッダ "retry-after" の秒数待ち再度リクエストを行う。

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

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

コンストラクタの詳細

PushNotificationService

public PushNotificationService()

メソッドの詳細

init

public void init(Config config)

destroy

public void destroy()

pushImpl

protected PushNotificationResult pushImpl(Tenant tenant,
                                          PushNotification notification)

requestPushApiExponentialBackoff

protected PushNotificationResponseDetail requestPushApiExponentialBackoff(PushNotificationTarget target,
                                                                          java.util.Map<java.lang.String,java.lang.Object> messageResource)

指数バックオフリトライを考慮した、FCM V1 API リクエストを行う

リトライ可能なエラーの場合は、レスポンスヘッダ "retry-after" の秒数待ち再度リクエストを行う。 それ以外の場合は、リトライせず処理を終了する。

パラメータ:

target - 宛先情報

messageResource - メッセージリソース Map インスタンス

戻り値:

実行結果

requestPushApi

protected PushNotificationResponseDetail requestPushApi(PushNotificationTarget target,
                                                        java.util.Map<java.lang.String,java.lang.Object> messageResource)

FCM V1 API リクエストを行う

FCM 送信 API仕様 に沿ったリクエストを行う。 実行結果は handleResponse(PushNotificationTarget, int, String, long) でハンドリングする

パラメータ:

target - 宛先情報

messageResource - メッセージリソース Map インスタンス

戻り値:

実行結果

handleResponse

protected PushNotificationResponseDetail handleResponse(PushNotificationTarget target,
                                                        int code,
                                                        java.lang.String response,
                                                        long retryAfterSeconds)
                                                 throws java.io.IOException

実行結果をハンドリングする

外部サービスの実行結果を受け、通知の結果を生成する。

パラメータ:

target - 通知対象

code - API 実行結果（HttpStatus）

response - レスポンスボディ

retryAfterSeconds - 再実行間隔（秒）

戻り値:

実行結果詳細インスタンス

例外:

java.io.IOException - 入出力例外

postProcessOfReequestPushApi

protected void postProcessOfReequestPushApi(PushNotificationResponseDetail responseDetail)

通知APIリクエスト後処理

API の結果によって実行する処理を定義する。

パラメータ:

responseDetail -