ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder クラス

リファレンス

パッケージ:: com.azure.messaging.servicebus

Maven 成果物:: com.azure:azure-messaging-servicebus:7.17.0

java.lang.Object
- com.azure.messaging.servicebus.ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder

public final class ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder

セッションベースの Service Bus エンティティからのメッセージを使用するを作成 ServiceBusProcessorClient するためのビルダー。 ServiceBusProcessorClientは、と processError(Consumer<ServiceBusErrorContext> processError)を介してメッセージとエラーをprocessMessage(Consumer<ServiceBusReceivedMessageContext> processMessage)処理します。プロセッサは、セッションの処理を終了すると、処理する次のセッションをフェッチしようとします。

既定では、プロセッサは次の処理を行います。

メッセージを自動的に決済します。を使用して無効にする disableAutoComplete()
1 つのセッションを同時に処理します。を使用して構成 maxConcurrentSessions(int maxConcurrentSessions)
の 1 つのインスタンスを processMessage(Consumer<ServiceBusReceivedMessageContext> processMessage)呼び出します。を使用して構成 maxConcurrentCalls(int maxConcurrentCalls)

セッションが有効なプロセッサクライアントをインスタンス化する

// Function that gets called whenever a message is received.
 Consumer<ServiceBusReceivedMessageContext> onMessage = context -> {
     ServiceBusReceivedMessage message = context.getMessage();
     System.out.printf("Processing message. Session: %s, Sequence #: %s. Contents: %s%n",
         message.getSessionId(), message.getSequenceNumber(), message.getBody());
 };

 Consumer<ServiceBusErrorContext> onError = context -> {
     System.out.printf("Error when receiving messages from namespace: '%s'. Entity: '%s'%n",
         context.getFullyQualifiedNamespace(), context.getEntityPath());

     if (context.getException() instanceof ServiceBusException) {
         ServiceBusException exception = (ServiceBusException) context.getException();

         System.out.printf("Error source: %s, reason %s%n", context.getErrorSource(),
             exception.getReason());
     } else {
         System.out.printf("Error occurred: %s%n", context.getException());
     }
 };

 TokenCredential tokenCredential = new DefaultAzureCredentialBuilder().build();

 // Create the processor client via the builder and its sub-builder
 // 'fullyQualifiedNamespace' will look similar to "{your-namespace}.servicebus.windows.net"
 ServiceBusProcessorClient sessionProcessor = new ServiceBusClientBuilder()
     .credential(fullyQualifiedNamespace, tokenCredential)
     .sessionProcessor()
     .queueName(sessionEnabledQueueName)
     .receiveMode(ServiceBusReceiveMode.PEEK_LOCK)
     .disableAutoComplete()
     .maxConcurrentSessions(2)
     .processMessage(onMessage)
     .processError(onError)
     .buildProcessorClient();

 // Starts the processor in the background. Control returns immediately.
 sessionProcessor.start();

 // Stop processor and dispose when done processing messages.
 sessionProcessor.stop();
 sessionProcessor.close();

メソッドの概要

修飾子と型	メソッドと説明
ServiceBusProcessorClient	buildProcessorClient() 特定のキューまたはサブスクリプションからの読み取ServiceBusReceivedMessageりを担当するセッション対応 Service Bus プロセッサを作成します。
ServiceBusSessionProcessorClientBuilder	disableAutoComplete() 受信したメッセージの自動完了と自動破棄を無効にします。
ServiceBusSessionProcessorClientBuilder	maxAutoLockRenewDuration(Duration maxAutoLockRenewDuration) ロックの自動更新を続行する時間を設定します。
ServiceBusSessionProcessorClientBuilder	maxConcurrentCalls(int maxConcurrentCalls) このプロセッサで処理する必要がある同時実行メッセージの最大数。
ServiceBusSessionProcessorClientBuilder	maxConcurrentSessions(int maxConcurrentSessions) 最大でを処理することで、セッション処理のロールオーバーを `maxConcurrentSessions`有効にします。
ServiceBusSessionProcessorClientBuilder	prefetchCount(int prefetchCount) プロセッサのプリフェッチ数を設定します。
ServiceBusSessionProcessorClientBuilder	processError(Consumer<ServiceBusErrorContext> processError) メッセージの受信中にエラーが発生した場合に呼び出されるプロセッサのエラーハンドラー。
ServiceBusSessionProcessorClientBuilder	processMessage(Consumer<ServiceBusReceivedMessageContext> processMessage) メッセージの受信時に実行されるプロセッサのメッセージ処理コールバック。
ServiceBusSessionProcessorClientBuilder	queueName(String queueName) プロセッサを作成するキューの名前を設定します。
ServiceBusSessionProcessorClientBuilder	receiveMode(ServiceBusReceiveMode receiveMode) プロセッサの受信モードを設定します。
ServiceBusSessionProcessorClientBuilder	sessionIdleTimeout(Duration sessionIdleTimeout) 現在アクティブなセッションのメッセージの受信を待機する最大時間を設定します。
ServiceBusSessionProcessorClientBuilder	subQueue(SubQueue subQueue) 接続するの SubQueue 種類を設定します。
ServiceBusSessionProcessorClientBuilder	subscriptionName(String subscriptionName) リッスンするトピック内のサブスクリプションの名前を設定します。
ServiceBusSessionProcessorClientBuilder	topicName(String topicName) トピックの名前を設定します。

メソッドの継承元: java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

メソッドの詳細

buildProcessorClient

public ServiceBusProcessorClient buildProcessorClient()

特定のキューまたはサブスクリプションからの読み取ServiceBusReceivedMessageりを担当するセッション対応 Service Bus プロセッサを作成します。

Returns:

キューまたはサブスクリプションからメッセージを受信する新しい ServiceBusProcessorClient 。

disableAutoComplete

public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder disableAutoComplete()

受信したメッセージの自動完了と自動破棄を無効にします。既定では、正常に処理されたメッセージはです complete()。メッセージの処理中にエラーが発生した場合は、です abandon()。

Returns:

変更された ServiceBusSessionProcessorClientBuilder オブジェクトです。

maxAutoLockRenewDuration

public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder maxAutoLockRenewDuration(Duration maxAutoLockRenewDuration)

ロックの自動更新を続行する時間を設定します。自動更新を設定 Duration#ZERO または null 無効にします。モードの場合 RECEIVE_AND_DELETE 、自動更新は無効になっています。

Parameters:

maxAutoLockRenewDuration - ロックの自動更新を続行する時間。 Duration#ZERO または null は、自動更新が無効になっていることを示します。

Returns:

更新後の ServiceBusSessionProcessorClientBuilder オブジェクト。

maxConcurrentCalls

public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder maxConcurrentCalls(int maxConcurrentCalls)

このプロセッサで処理する必要がある同時実行メッセージの最大数。

Parameters:

maxConcurrentCalls - このプロセッサで処理する必要がある最大同時メッセージ数。

Returns:

更新後の ServiceBusSessionProcessorClientBuilder オブジェクト。

maxConcurrentSessions

public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder maxConcurrentSessions(int maxConcurrentSessions)

最大でを処理することで、セッション処理のロールオーバーを maxConcurrentSessions有効にします。

Parameters:

maxConcurrentSessions - 任意の時点で処理する同時セッションの最大数。

Returns:

変更された ServiceBusSessionProcessorClientBuilder オブジェクトです。

prefetchCount

public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder prefetchCount(int prefetchCount)

プロセッサのプリフェッチ数を設定します。モードと RECEIVE_AND_DELETE モードの両方PEEK_LOCKの場合、既定値は 0 です。プリフェッチは、アプリケーションがプロセッサを起動する前に、ローカルの取得にメッセージをすぐに使用できるようにすることを目的として、メッセージフローを高速化します。 0 以外の値を設定すると、その数のメッセージがプリフェッチされます。値を 0 に設定すると、プリフェッチがオフになります。 0 以外のプリフェッチを使用すると、パフォーマンスが向上してもメッセージが失われるリスクがあります。

Parameters:

prefetchCount - プリフェッチ数。

Returns:

変更された ServiceBusProcessorClientBuilder オブジェクトです。

processError

public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder processError(Consumer processError)

メッセージの受信中にエラーが発生した場合に呼び出されるプロセッサのエラーハンドラー。

Parameters:

processError - エラーが発生したときに実行されるエラーハンドラー。

Returns:

更新された ServiceBusProcessorClientBuilder オブジェクト

processMessage

public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder processMessage(Consumer processMessage)

メッセージの受信時に実行されるプロセッサのメッセージ処理コールバック。

Parameters:

processMessage - メッセージの受信時に実行されるメッセージ処理コンシューマー。

Returns:

更新後の ServiceBusProcessorClientBuilder オブジェクト。

queueName

public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder queueName(String queueName)

プロセッサを作成するキューの名前を設定します。

Parameters:

queueName - キューの名前。

Returns:

変更された ServiceBusSessionProcessorClientBuilder オブジェクトです。

receiveMode

public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder receiveMode(ServiceBusReceiveMode receiveMode)

プロセッサの受信モードを設定します。

Parameters:

receiveMode - メッセージ受信用のモード。

Returns:

変更された ServiceBusSessionProcessorClientBuilder オブジェクトです。

sessionIdleTimeout

public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder sessionIdleTimeout(Duration sessionIdleTimeout)

現在アクティブなセッションのメッセージの受信を待機する最大時間を設定します。この時間が経過すると、プロセッサのセッションが終了し、別のセッションの処理が試みられます。

プロセッサがハンドラーにメッセージを配信した後、セッション内に processMessage(Consumer<ServiceBusReceivedMessageContext> processMessage) 次のメッセージがないためにプロセッサがセッションから次のメッセージを受信できない場合、または現在のメッセージの処理に時間 sessionIdleTimeout がかかる場合、セッションはタイムアウトします。セッションが誤って失われるのを防ぐには、メッセージの処理時間よりも長いを選択 sessionIdleTimeout します。

指定しない場合は、が AmqpRetryOptions#getTryTimeout() 使用されます。

Parameters:

sessionIdleTimeout - セッションアイドルタイムアウト。

Returns:

更新後の ServiceBusSessionProcessorClientBuilder オブジェクト。

subQueue

public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder subQueue(SubQueue subQueue)

接続するの SubQueue 種類を設定します。 Azure Service Bus キューとサブスクリプションは、配信不能キュー (DLQ) と呼ばれるセカンダリサブキューを提供します。

Parameters:

subQueue - サブキューの種類。

Returns:

変更された ServiceBusSessionProcessorClientBuilder オブジェクトです。

subscriptionName

public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder subscriptionName(String subscriptionName)

リッスンするトピック内のサブスクリプションの名前を設定します。 topicName(String topicName) も設定する必要があります。

Parameters:

subscriptionName - サブスクリプションの名前。

Returns:

変更された ServiceBusSessionProcessorClientBuilder オブジェクトです。

topicName

public ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder topicName(String topicName)

トピックの名前を設定します。 subscriptionName(String subscriptionName) も設定する必要があります。

Parameters:

topicName - トピックの名前。

Returns:

変更された ServiceBusSessionProcessorClientBuilder オブジェクトです。

次の方法で共有

ServiceBusClientBuilder.ServiceBusSessionProcessorClientBuilder クラス

メソッドの概要

メソッドの継承元: java.lang.Object

メソッドの詳細

buildProcessorClient

disableAutoComplete

maxAutoLockRenewDuration

maxConcurrentCalls

maxConcurrentSessions

prefetchCount

processError

processMessage

queueName

receiveMode

sessionIdleTimeout

subQueue

subscriptionName

topicName

適用対象

その他のリソース