この記事では、Vault Java SDK を使用して作成されたカスタムジョブで使用するキューの作成および管理について説明します。詳細は、開発者ポータルの Vault Java SDK を参照してください。
SDK ジョブキューを使うと、カスタムキューでメッセージの処理 (別名: タスク) を行うことができ、1 つのシステムキューですべてのメッセージを処理する必要がありません。これは、パフォーマンス上のメリットがあるだけでなく、一度にすべてのキューではなく、特定のキューを有効化または無効化することができます。
SDK ジョブキューの管理へアクセスする
管理者 > ジョブ > SDK ジョブキューからキューの表示と管理を行います。キューを設定するためには、管理者 > SDK ジョブキュー権限が付与されたセキュリティプロファイルを持っている必要があります。
SDK ジョブキューを作成する方法
新規キューを作成するには:
- SDK ジョブキューページから、作成をクリックします。
- このキューのラベルを入力します。これは、Vault UI の管理者に表示されるラベルです。
- Vault は名前フィールドに自動入力します。これは、Vault Java SDK コードからコールされた際のキューの名前です。必要に応じてこの名前を変更することができます。小文字、英数字、文字間のアンダースコア 1 文字 (_) のみが許可されます。
- このキューのステータスを入力します。アクティブなキューのみがメッセージを受け取ることができます。
- 任意の作業: このキューに説明を入力します。
- 保存をクリックします。
SDK ジョブキューを作成したら、それを SDK ジョブメタデータに追加することができます。
SDK ジョブキューを無効化する方法
SDK ジョブキューのメッセージ受信を停止したい場合は、キューのステータスを無効に設定する必要があります。無効にすると、キューは新規メッセージを受信できなくなります。
これによって、キューに既に存在するメッセージが処理されないようにすることはできません。例えば、キューを無効化する前にキューにメッセージがあった場合、それらのメッセージは処理されます。キューに既に存在するメッセージの処理を停止したい場合は、デリバリを無効化する必要があります。
キューを無効化するには:
- キューの詳細ページで、編集をクリックします。
- ステータスを無効に設定します。
- 保存をクリックします。
無効なキューが直ちにメッセージの受け取りを停止します。キューを再度有効化したい場合は、同じ手順で行います。キューが有効になったら、再度メッセージの受け取りを開始します。
デリバリを無効化する方法
SDK ジョブキューによるジョブプロセッサに対する既存のメッセージ配信を停止したい場合は、デリバリを無効化する必要があります。これによって、新規メッセージがキューに入ることを防ぐことはできません。例えば、デリバリステータスが無効化に設定されたアクティブなキューでは、新規メッセージはキューに入れますが、キューから出ていくメッセージはありません。
キューを無効化するには:
- デリバリを無効化したい SDK ジョブキューに進みます。
- すべてのアクションメニューからデリバリの無効化を選択します。
- これでキューが無効化されます。キューの詳細で、デリバリステータスが無効と表示されます。
このキューによるプロセッサに対するメッセージのデリバリを再開したい場合は、同じ手順でキューを有効化します。
SDK ジョブキューのすべてのメッセージを削除する方法
キューのステータスまたはデリバリステータスを変更しても、キューのメッセージは削除されません。例えば、デリバリステータスが無効に設定されたアクティブでないキューは、メッセージの受信または処理はできませんが、キューのメッセージは残ります。これらのメッセージが不要になったらキューをリセットすることができます。
キューの再設定は永続的で取り消すことはできません。
キューをリセットするには:
- リセットした SDK ジョブキューの詳細ページに進みます。
- キューのリセットをクリックします。
- 警告を読んだら続行をクリックします。
- 処理が完了したら、Vault が正常にキューをリセットしたことを告げるシステムメッセージが緑色のバナーで表示されます。