クラス MessageProperties
java.lang.ObjectSE
org.springframework.amqp.core.MessageProperties
- 実装済みのインターフェース一覧:
SerializableSE
- 既知の直属サブクラス
StreamMessageProperties
AMQP メッセージのメッセージプロパティ。
- 作成者:
- Mark Fisher, Mark Pollack, Gary Russell, Dmitry Chernyshov, Artem Bilan, Csaba Soti, Raylax Grey, Ngoc Nhan
- 関連事項:
フィールドのサマリー
フィールド修飾子と型フィールド説明static final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final StringSEstatic final MessageDeliveryModestatic final IntegerSEstatic final StringSEメッセージの再公開の再試行回数を表すカスタムヘッダー。static final StringSEstatic final StringSEstatic final StringSEstatic final longX-Delay ヘッダーの最大値。コンストラクター概要
コンストラクター方法の概要
修飾子と型メソッド説明boolean@Nullable AmqpAcknowledgmentコンシューマー向けのAmqpAcknowledgmentがある場合はそれを返却します。@Nullable StringSEgetAppId()@Nullable StringSE@Nullable StringSE@Nullable StringSE@Nullable StringSElong@Nullable StringSE相関 ID を取得します。@Nullable LongSEX-Delay ヘッダーの Long 値を取得します。@Nullable MessageDeliveryModelong@Nullable StringSEメッセージの有効期限を取得します。<T> @Nullable Tヘッダーに getter と入力しました。@Nullable TypeSEメソッドレベルの@RabbitListenerを使用する場合に推定されるターゲット引数の型。@Nullable IntegerSEキューに残っているメッセージ数のサーバーの最新の見積もりを返します。@Nullable StringSElong発行者の確認が有効になっている場合は、テンプレートによって設定された発行シーケンス番号を返します。@Nullable LongSE遅延メッセージ交換が使用される場合、受信メッセージの x-delay ヘッダーに遅延が含まれます。@Nullable MessageDeliveryMode@Nullable StringSE@Nullable StringSE@Nullable StringSE受信メッセージからユーザー ID を返します。@Nullable BooleanSE@Nullable StringSE@Nullable Addresslongブローカー経由のこのメッセージの再試行回数。@Nullable ObjectSE@RabbitListenerを使用する場合のターゲット Bean。@Nullable MethodSE@RabbitListenerを使用する場合のターゲットメソッド。@Nullable DateSE@Nullable StringSEgetType()@Nullable StringSEx-death ヘッダーを返します。inthashCode()voidこのメッセージがブローカーに再発行されるときに、このメッセージの再試行回数を増やします。protected final booleanprotected final booleanbooleanbooleantrue の場合。これらのプロパティを持つメッセージは、バッチからの最後のメッセージです。boolean変換が射影を使用したことを伝えるために使用される内部フラグを取得します。アプリケーションレベルでは常に false です。@Nullable BooleanSEvoidsetAmqpAcknowledgment(AmqpAcknowledgment amqpAcknowledgment) ターゲットメッセージプロセッサーで手動 ACK 用のAmqpAcknowledgmentを設定します。voidvoidsetClusterId(StringSE clusterId) voidsetConsumerQueue(StringSE consumerQueue) voidsetConsumerTag(StringSE consumerTag) voidsetContentEncoding(@Nullable StringSE contentEncoding) voidsetContentLength(long contentLength) voidsetContentType(StringSE contentType) voidsetCorrelationId(@Nullable StringSE correlationId) 相関 ID を設定します。voidsetDelayLong(@Nullable LongSE delay) x-lay ヘッダーを長い値に設定します。voidsetDeliveryMode(@Nullable MessageDeliveryMode deliveryMode) voidsetDeliveryTag(long deliveryTag) voidsetExpiration(StringSE expiration) メッセージの有効期限を設定します。voidsetFinalRetryForMessageWithNoId(boolean finalRetryForMessageWithNoId) voidvoidsetHeaders(MapSE<StringSE, ObjectSE> headers) ヘッダーを設定します。voidsetInferredArgumentType(TypeSE inferredArgumentType) メソッドレベルの@RabbitListenerを使用する場合は、推定されるターゲット引数の型を設定します。voidsetLastInBatch(boolean lastInBatch) これらのプロパティがバッチ内の最後のメッセージ用であることを示すには、true に設定します。voidsetMessageCount(IntegerSE messageCount) メッセージ数を設定します。voidsetMessageId(StringSE messageId) voidsetPriority(IntegerSE priority) voidsetProjectionUsed(boolean projectionUsed) 変換が射影を使用したことを伝えるために使用される内部フラグを設定します。アプリケーションレベルでは常に false です。voidsetPublishSequenceNumber(long publishSequenceNumber) 発行者の確認が有効になっている場合は、テンプレートによって設定される発行シーケンス番号を設定します。voidsetReceivedDelayLong(LongSE receivedDelay) 遅延メッセージ交換が使用される場合、受信メッセージの x-delay ヘッダーに遅延が含まれます。voidsetReceivedDeliveryMode(MessageDeliveryMode receivedDeliveryMode) voidsetReceivedExchange(StringSE receivedExchange) voidsetReceivedRoutingKey(StringSE receivedRoutingKey) voidsetReceivedUserId(StringSE receivedUserId) voidsetRedelivered(BooleanSE redelivered) voidsetReplyTo(@Nullable StringSE replyTo) voidsetReplyToAddress(@Nullable Address replyTo) voidsetRetryCount(long retryCount) ブローカー経由でこのメッセージの再試行回数を設定します。voidsetTargetBean(@Nullable ObjectSE targetBean) @RabbitListenerを使用する場合は、対象の Bean を設定します。voidsetTargetMethod(@Nullable MethodSE targetMethod) @RabbitListenerを使用する場合のターゲットメソッドを設定します。voidsetTimestamp(DateSE timestamp) voidvoidtoString()
フィールドの詳細
CONTENT_TYPE_BYTES
- 関連事項:
CONTENT_TYPE_TEXT_PLAIN
- 関連事項:
CONTENT_TYPE_SERIALIZED_OBJECT
- 関連事項:
CONTENT_TYPE_JSON
- 関連事項:
CONTENT_TYPE_JSON_ALT
- 関連事項:
CONTENT_TYPE_XML
- 関連事項:
SPRING_BATCH_FORMAT
- 関連事項:
BATCH_FORMAT_LENGTH_HEADER4
- 関連事項:
SPRING_AUTO_DECOMPRESS
- 関連事項:
X_DELAY
- 関連事項:
RETRY_COUNT
メッセージの再発行の再試行回数を表すカスタムヘッダー。サーバー側 DLX の場合、このヘッダーにはx-death.countプロパティの値が含まれます。再発行が手動で行われる場合、このヘッダーはアプリケーションによって増分される必要があります。- 関連事項:
DEFAULT_CONTENT_TYPE
- 関連事項:
DEFAULT_DELIVERY_MODE
DEFAULT_PRIORITY
X_DELAY_MAX
public static final long X_DELAY_MAXX-Delay ヘッダーの最大値。- 導入:
- 3.1.2
- 関連事項:
コンストラクターの詳細
MessageProperties
public MessageProperties()
メソッドの詳細
setHeader
setHeaders
ヘッダーを設定します。- パラメーター:
headers- ヘッダー。- 導入:
- 2.4.7
getHeader
ヘッダーに getter と入力しました。- 型パラメーター:
T- 型。- パラメーター:
headerName- ヘッダー名。- 戻り値:
- ヘッダー値
- 導入:
- 2.2
getHeaders
setTimestamp
getTimestamp
setMessageId
getMessageId
setUserId
getUserId
getReceivedUserId
受信メッセージからユーザー ID を返します。- 戻り値:
- ユーザー ID。
- 導入:
- 1.6
setReceivedUserId
setAppId
getAppId
setClusterId
getClusterId
setType
getType
setCorrelationId
相関 ID を設定します。- パラメーター:
correlationId- ID。
getCorrelationId
相関 ID を取得します。- 戻り値:
- ID。
setReplyTo
getReplyTo
setReplyToAddress
getReplyToAddress
setContentType
getContentType
setContentEncoding
getContentEncoding
setContentLength
public void setContentLength(long contentLength) getContentLength
public long getContentLength()isContentLengthSet
protected final boolean isContentLengthSet()setDeliveryMode
getDeliveryMode
getReceivedDeliveryMode
setReceivedDeliveryMode
setExpiration
メッセージの有効期限を設定します。これは、AMQP 0.9.1 仕様ごとの String プロパティです。RabbitMQ の場合、これはメッセージの存続時間をミリ秒単位で表した文字列です。- パラメーター:
expiration- 有効期限。
getExpiration
メッセージの有効期限を取得します。これは、AMQP 0.9.1 仕様ごとの String プロパティです。RabbitMQ の場合、これはメッセージの存続時間をミリ秒単位で表した文字列です。- 戻り値:
- 有効期限。
setPriority
getPriority
setReceivedExchange
getReceivedExchange
setReceivedRoutingKey
getReceivedRoutingKey
getReceivedDelayLong
遅延メッセージ交換が使用される場合、受信メッセージの x-delay ヘッダーに遅延が含まれます。- 戻り値:
- 受け取った遅延。
- 導入:
- 3.1.2
- 関連事項:
setReceivedDelayLong
遅延メッセージ交換が使用される場合、受信メッセージの x-delay ヘッダーに遅延が含まれます。- パラメーター:
receivedDelay- 受け取った遅延。- 導入:
- 3.1.2
- 関連事項:
setRedelivered
isRedelivered
getRedelivered
setDeliveryTag
public void setDeliveryTag(long deliveryTag) getDeliveryTag
public long getDeliveryTag()isDeliveryTagSet
protected final boolean isDeliveryTagSet()setMessageCount
メッセージ数を設定します。- パラメーター:
messageCount- カウント- 関連事項:
getMessageCount
キューに残っているメッセージ数のサーバーの最新の見積もりを返します。basicGet経由で取得されたメッセージにのみ適用されます。- 戻り値:
- カウント。
getConsumerTag
setConsumerTag
getConsumerQueue
setConsumerQueue
getDelayLong
X-Delay ヘッダーの Long 値を取得します。- 戻り値:
- 遅延。
- 導入:
- 3.1.2
setDelayLong
x-lay ヘッダーを長い値に設定します。- パラメーター:
delay- 遅延。- 導入:
- 3.1.2
getRetryCount
public long getRetryCount()ブローカー経由のこのメッセージの再試行回数。- 戻り値:
- 再試行回数
- 導入:
- 3.2
setRetryCount
public void setRetryCount(long retryCount) ブローカー経由でこのメッセージの再試行回数を設定します。- パラメーター:
retryCount- 再試行回数。- 導入:
- 3.2
- 関連事項:
incrementRetryCount
public void incrementRetryCount()このメッセージがブローカーに再発行されるときに、このメッセージの再試行回数を増やします。- 導入:
- 3.2
isFinalRetryForMessageWithNoId
public boolean isFinalRetryForMessageWithNoId()setFinalRetryForMessageWithNoId
public void setFinalRetryForMessageWithNoId(boolean finalRetryForMessageWithNoId) getPublishSequenceNumber
public long getPublishSequenceNumber()発行者の確認が有効になっている場合は、テンプレートによって設定された発行シーケンス番号を返します。- 戻り値:
- シーケンス番号。
- 導入:
- 2.1
setPublishSequenceNumber
public void setPublishSequenceNumber(long publishSequenceNumber) 発行者の確認が有効になっている場合は、テンプレートによって設定される発行シーケンス番号を設定します。- パラメーター:
publishSequenceNumber- シーケンス番号。- 導入:
- 2.1
getInferredArgumentType
メソッドレベルの@RabbitListenerを使用する場合に推定されるターゲット引数の型。- 戻り値:
- 型。
- 導入:
- 1.6
setInferredArgumentType
メソッドレベルの@RabbitListenerを使用する場合は、推定されるターゲット引数の型を設定します。- パラメーター:
inferredArgumentType- 型。- 導入:
- 1.6
getTargetMethod
@RabbitListenerを使用する場合のターゲットメソッド。- 戻り値:
- メソッド。
- 導入:
- 1.6
setTargetMethod
@RabbitListenerを使用する場合のターゲットメソッドを設定します。- パラメーター:
targetMethod- ターゲットメソッド。- 導入:
- 1.6
getTargetBean
@RabbitListenerを使用する場合のターゲット Bean。- 戻り値:
- Bean。
- 導入:
- 1.6
setTargetBean
@RabbitListenerを使用する場合は、対象の Bean を設定します。- パラメーター:
targetBean- Bean。- 導入:
- 1.6
isLastInBatch
public boolean isLastInBatch()true の場合。これらのプロパティを持つメッセージは、バッチからの最後のメッセージです。- 戻り値:
- 最後のメッセージの場合は true。
- 導入:
- 2.2
setLastInBatch
public void setLastInBatch(boolean lastInBatch) これらのプロパティがバッチ内の最後のメッセージ用であることを示すには、true に設定します。- パラメーター:
lastInBatch- 最後に当てはまります。- 導入:
- 2.2
isProjectionUsed
public boolean isProjectionUsed()変換が射影を使用したことを伝えるために使用される内部フラグを取得します。アプリケーションレベルでは常に false です。- 戻り値:
- 射影が使用された場合は true。
- 導入:
- 2.2.20
setProjectionUsed
public void setProjectionUsed(boolean projectionUsed) 変換が射影を使用したことを伝えるために使用される内部フラグを設定します。アプリケーションレベルでは常に false です。- パラメーター:
projectionUsed- 射影の場合は true。- 導入:
- 2.2.20
getXDeathHeader
x-death ヘッダーを返します。- 戻り値:
- ヘッダー。
getAmqpAcknowledgment
コンシューマー向けのAmqpAcknowledgmentがある場合はそれを返却します。- 戻り値:
- コンシューマー向けの
AmqpAcknowledgment(存在する場合)。 - 導入:
- 4.0
setAmqpAcknowledgment
ターゲットメッセージプロセッサーで手動確認応答(ACK)用のAmqpAcknowledgmentを設定します。これはアプリケーション内、コンシューマー側ロジックのみで実行されます。- パラメーター:
amqpAcknowledgment- アプリケーションで使用するAmqpAcknowledgment。- 導入:
- 4.0
hashCode
public int hashCode()equals
toString