クラス AbstractKeyValueMessageStore

メソッドの詳細

• getMessagePrefix

  public StringSE getMessagePrefix()

  同じターゲットキー / 値データベース内の異なるストアインスタンスを区別するために、メッセージキーの構成済みプレフィックスを返します。デフォルトは "MESSAGE_" (カスタムプレフィックスなし) です。

  戻り値:

  キーのプレフィックス

  導入:

  4.3.12

• getGroupPrefix

  public StringSE getGroupPrefix()

  同じターゲットキー / 値データベース内の異なるストアインスタンスを区別するために、メッセージグループキーの構成済みプレフィックスを返します。デフォルトは "GROUP_OF_MESSAGES_" (カスタムプレフィックスなし) です。

  戻り値:

  キーのプレフィックス

  導入:

  4.3.12

• getMessage

  public Message<?> getMessage(UUIDSE messageId)

  次で指定:

  インターフェース MessageStore の getMessage 

  パラメーター:

  messageId - メッセージ識別子。

  戻り値:

  指定された ID のメッセージ。MessageStore にその ID のメッセージが存在しない場合は null。

• getMessageMetadata

  public MessageMetadata getMessageMetadata(UUIDSE messageId)

  インターフェースからコピーされた説明: MessageStore

  提供された id によって Message の MessageMetadata を返します。

  次で指定:

  インターフェース MessageStore の getMessageMetadata 

  パラメーター:

  messageId - メッセージ識別子。

  戻り値:

  指定された ID の MessageMetadata、またはその ID のメッセージが MessageStore に存在しないか、メッセージにメタデータがない場合（以前のバージョンのレガシーメッセージ）は null。

• addMessage

  public <T> Message<T> addMessage(Message<T> message)

  インターフェースからコピーされた説明: MessageStore

  提供されたメッセージを MessageStore に入れます。ストアはメッセージを内部で変更する必要がある場合があり、その場合、戻り値は入力と異なる場合があります。戻り値の ID は、MessageStore.getMessage(UUID) および MessageStore.removeMessage(UUID) が正しく動作するようにインデックスとして使用されます。メッセージは不変であるため、同じメッセージを複数回入力しても何も起こりません。

  次で指定:

  インターフェース MessageStore の addMessage 

  型パラメーター:

  T - ペイロード型。

  パラメーター:

  message - メッセージ。

  戻り値:

  保存されたメッセージ。

• doAddMessage

  protected void doAddMessage(Message<?> message)

• doAddMessage

  protected void doAddMessage(Message<?> message, @Nullable ObjectSE groupId)

• removeMessage

  public Message<?> removeMessage(UUIDSE id)

  インターフェースからコピーされた説明: MessageStore

  指定された ID を持つメッセージが MessageStore から削除されます (存在する場合)。その ID を持つメッセージがストアに存在しない場合は、null が返されます。このメソッドが MessageGroupStore に実装されている場合、このメッセージを保持するグループがない場合にのみ、メッセージはストアから削除されます。

  次で指定:

  インターフェース MessageStore の removeMessage 

  パラメーター:

  id - メッセージ識別子。

  戻り値:

  メッセージ (ある場合)。

• getMessageCount

  @ManagedAttribute public long getMessageCount()

  インターフェースからコピーされた説明: MessageStore

  ストア内のメッセージ数を示すオプションの属性。実装は例外をスローすることで応答を拒否する場合があります。

  次で指定:

  インターフェース MessageStore の getMessageCount 

  戻り値:

  メッセージの数。

• getMessageGroup

  public MessageGroup getMessageGroup(ObjectSE groupId)

  必要に応じて、SimpleMessageGroup の新しいインスタンスを作成します。

  次で指定:

  インターフェース BasicMessageGroupStore の getMessageGroup 

  パラメーター:

  groupId - グループ識別子。

  戻り値:

  メッセージのグループ。このキーにメッセージが存在しない場合は空です。

• getGroupMetadata

  public MessageGroupMetadata getGroupMetadata(ObjectSE groupId)

  インターフェースからコピーされた説明: MessageGroupStore

  メッセージをフェッチせずにグループメタデータを取得します。他のすべてのグループプロパティを提供する必要があります。最初のメッセージの ID を含めることができます。

  次で指定:

  インターフェース MessageGroupStore の getGroupMetadata 

  オーバーライド:

  クラス AbstractMessageGroupStore の getGroupMetadata 

  パラメーター:

  groupId - グループ ID。

  戻り値:

  メタデータ。

• addMessagesToGroup

  public void addMessagesToGroup(ObjectSE groupId, Message<?>... messages)

  インターフェースからコピーされた説明: MessageGroupStore

  グループ ID に関連付けてメッセージを保存します。これは、メッセージをグループ化するために使用できます。

  次で指定:

  インターフェース MessageGroupStore の addMessagesToGroup 

  パラメーター:

  groupId - メッセージを保存するグループ ID。

  messages - 追加するメッセージ。

• removeMessagesFromGroup

  public void removeMessagesFromGroup(ObjectSE groupId, CollectionSE<Message<?>> messages)

  インターフェースからコピーされた説明: MessageGroupStore

  グループからのメッセージの削除を永続化します。

  次で指定:

  インターフェース MessageGroupStore の removeMessagesFromGroup 

  パラメーター:

  groupId - メッセージを含むグループの groupId。

  messages - 削除するメッセージ。

• getMessageFromGroup

  @Nullable public Message<?> getMessageFromGroup(ObjectSE groupId, UUIDSE messageId)

  インターフェースからコピーされた説明: MessageGroupStore

  ID を使用してグループから Message を取得します。メッセージがリクエストされたグループに属していない場合は、null を返します。

  次で指定:

  インターフェース MessageGroupStore の getMessageFromGroup 

  パラメーター:

  groupId - メッセージを含むグループの groupId。

  messageId - メッセージ ID。

  戻り値:

  リクエストされたグループに属している場合は、ID によるメッセージ。

• removeMessageFromGroupById

  public boolean removeMessageFromGroupById(ObjectSE groupId, UUIDSE messageId)

  インターフェースからコピーされた説明: MessageGroupStore

  グループからメッセージを削除します。

  次で指定:

  インターフェース MessageGroupStore の removeMessageFromGroupById 

  パラメーター:

  groupId - メッセージを含むグループの groupId。

  messageId - 削除するメッセージ ID。

  戻り値:

  メッセージが削除された場合は true。

• completeGroup

  public void completeGroup(ObjectSE groupId)

  インターフェースからコピーされた説明: MessageGroupStore

  これで MessageGroup が完成します。MessageGroup の補完は一般に、このグループに対してそれ以上の変異操作の実行を許可すべきではないことを意味します。たとえば、グループから新しいメッセージを追加 / 削除する試みは許可されるべきではありません。

  次で指定:

  インターフェース MessageGroupStore の completeGroup 

  パラメーター:

  groupId - グループ識別子。

• removeMessageGroup

  public void removeMessageGroup(ObjectSE groupId)

  提供されたグループ ID を持つ MessageGroup を削除します。

  次で指定:

  インターフェース BasicMessageGroupStore の removeMessageGroup 

  パラメーター:

  groupId - 削除するグループの ID。

• setGroupCondition

  public void setGroupCondition(ObjectSE groupId, StringSE condition)

  インターフェースからコピーされた説明: MessageGroupStore

  グループに条件文を追加します。後でグループの意思決定に使用できます。相関ハンドラーのリリース戦略では、グループ内のすべてのメッセージを繰り返す代わりに、この条件を調べることができます。

  次で指定:

  インターフェース MessageGroupStore の setGroupCondition 

  パラメーター:

  groupId - グループ識別子。

  condition - グループに保存する条件。

• setLastReleasedSequenceNumberForGroup

  public void setLastReleasedSequenceNumberForGroup(ObjectSE groupId, int sequenceNumber)

  インターフェースからコピーされた説明: MessageGroupStore

  最後にリリースされたメッセージのシーケンス番号を設定できます。ユースケースの並べ替えに使用

  次で指定:

  インターフェース MessageGroupStore の setLastReleasedSequenceNumberForGroup 

  パラメーター:

  groupId - グループ識別子。

  sequenceNumber - シーケンス番号。

• pollMessageFromGroup

  public Message<?> pollMessageFromGroup(ObjectSE groupId)

  インターフェースからコピーされた説明: BasicMessageGroupStore

  この MessageGroup からのメッセージのポーリング（実装でサポートされている場合は FIFO スタイル）と同時に、ポーリングされた Message も削除します。

  次で指定:

  インターフェース BasicMessageGroupStore の pollMessageFromGroup 

  パラメーター:

  groupId - グループ識別子。

  戻り値:

  メッセージ。

• getOneMessageFromGroup

  public Message<?> getOneMessageFromGroup(ObjectSE groupId)

  インターフェースからコピーされた説明: MessageGroupStore

  MessageGroup から 1 つの Message を返します。

  次で指定:

  インターフェース MessageGroupStore の getOneMessageFromGroup 

  パラメーター:

  groupId - グループ識別子。

  戻り値:

  Message

• getMessagesForGroup

  public CollectionSE<Message<?>> getMessagesForGroup(ObjectSE groupId)

  インターフェースからコピーされた説明: MessageGroupStore

  指定されたグループ ID のメッセージを取得します。

  次で指定:

  インターフェース MessageGroupStore の getMessagesForGroup 

  パラメーター:

  groupId - メッセージを取得するグループ ID。

  戻り値:

  グループのメッセージ。

• streamMessagesForGroup

  public StreamSE<Message<?>> streamMessagesForGroup(ObjectSE groupId)

  インターフェースからコピーされた説明: MessageGroupStore

  指定されたグループに保存されているメッセージのストリームを返します。永続的な実装は、完全に処理されたら閉じる必要があるストリームを返します（たとえば、try-with-resources 句を使用）。デフォルトでは、MessageGroupStore.getMessagesForGroup(Object) の結果をストリーミングします。

  次で指定:

  インターフェース MessageGroupStore の streamMessagesForGroup 

  パラメーター:

  groupId - メッセージを取得するためのグループ ID。

  戻り値:

  このグループのメッセージの StreamSE。

• iterator

  public IteratorSE<MessageGroup> iterator()

  次で指定:

  インターフェース IterableSE<MessageGroup> の iterator 

  次で指定:

  インターフェース MessageGroupStore の iterator 

  戻り値:

  現在累積されている MessageGroup の反復子。

• messageGroupSize

  public int messageGroupSize(ObjectSE groupId)

  インターフェースからコピーされた説明: BasicMessageGroupStore

  この MessageGroup のサイズを返します。

  次で指定:

  インターフェース BasicMessageGroupStore の messageGroupSize 

  パラメーター:

  groupId - グループ識別子。

  戻り値:

  サイズ。

• doRetrieve

  protected abstract ObjectSE doRetrieve(ObjectSE id)

• doStore

  protected abstract void doStore(ObjectSE id, ObjectSE objectToStore)

• doStoreIfAbsent

  protected abstract void doStoreIfAbsent(ObjectSE id, ObjectSE objectToStore)

• doRemove

  protected abstract ObjectSE doRemove(ObjectSE id)

• doRemoveAll

  protected abstract void doRemoveAll(CollectionSE<ObjectSE> ids)

• doListKeys

  protected abstract CollectionSE<?> doListKeys(StringSE keyPattern)