クラス AbstractKeyValueMessageStore

方法の詳細

• getMessagePrefix

  public StringSE getMessagePrefix()

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

  戻り値:

  キーのプレフィックス

  導入:

  4.3.12

• getGroupPrefix

  public StringSE getGroupPrefix()

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

  戻り値:

  キーのプレフィックス

  導入:

  4.3.12

• getMessage

  public @Nullable Message<?> getMessage(UUIDSE messageId)

  次で指定:

  インターフェース MessageStore 内の getMessage 

  パラメーター:

  messageId - メッセージ識別子。

  戻り値:

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

• getMessageMetadata

  public @Nullable 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 @Nullable 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 @Nullable MessageGroupMetadata getGroupMetadata(ObjectSE groupId)

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

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

  次で指定:

  インターフェース MessageGroupStore 内の getGroupMetadata 

  パラメーター:

  groupId - グループ ID。

  戻り値:

  メタデータ。

• doAddMessagesToGroup

  protected void doAddMessagesToGroup(ObjectSE groupId, Message<?>... messages)

  次で指定:

  クラス AbstractMessageGroupStore の doAddMessagesToGroup 

• doRemoveMessagesFromGroup

  protected void doRemoveMessagesFromGroup(ObjectSE groupId, CollectionSE<Message<?>> messages)

  次で指定:

  クラス AbstractMessageGroupStore の doRemoveMessagesFromGroup 

• getMessageFromGroup

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

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

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

  次で指定:

  インターフェース MessageGroupStore 内の getMessageFromGroup 

  パラメーター:

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

  messageId - メッセージ ID。

  戻り値:

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

• doRemoveMessageFromGroupById

  protected boolean doRemoveMessageFromGroupById(ObjectSE groupId, UUIDSE messageId)

  オーバーライド:

  クラス AbstractMessageGroupStore の doRemoveMessageFromGroupById 

• doCompleteGroup

  protected void doCompleteGroup(ObjectSE groupId)

  次で指定:

  クラス AbstractMessageGroupStore の doCompleteGroup 

• doRemoveMessageGroup

  protected void doRemoveMessageGroup(ObjectSE groupId)

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

  次で指定:

  クラス AbstractMessageGroupStore の doRemoveMessageGroup 

• doSetGroupCondition

  protected void doSetGroupCondition(ObjectSE groupId, StringSE condition)

  次で指定:

  クラス AbstractMessageGroupStore の doSetGroupCondition 

• doSetLastReleasedSequenceNumberForGroup

  protected void doSetLastReleasedSequenceNumberForGroup(ObjectSE groupId, int sequenceNumber)

  次で指定:

  クラス AbstractMessageGroupStore の doSetLastReleasedSequenceNumberForGroup 

• doPollMessageFromGroup

  protected @Nullable Message<?> doPollMessageFromGroup(ObjectSE groupId)

  次で指定:

  クラス AbstractMessageGroupStore の doPollMessageFromGroup 

• getOneMessageFromGroup

  public @Nullable 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 @Nullable 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 @Nullable ObjectSE doRemove(ObjectSE id)

• doRemoveAll

  protected abstract void doRemoveAll(CollectionSE<ObjectSE> ids)

• doListKeys

  protected abstract @Nullable CollectionSE<?> doListKeys(StringSE keyPattern)