ConnectionStringBuilder クラス

パッケージ:

com.microsoft.azure.servicebus.primitives

Maven 成果物:

com.microsoft.azure:azure-servicebus:3.6.7

• java.lang.Object
• • com.microsoft.azure.servicebus.primitives.ConnectionStringBuilder

public class ConnectionStringBuilder

このクラスを使用して、ServiceBus エンティティとの通信を確立できる接続文字列を構築できます。 また、既存の接続文字列に対して基本的な検証を実行するためにも使用できます。

サンプル コード:

ConnectionStringBuilder connectionStringBuilder = new ConnectionStringBuilder(
                                          "ServiceBusNamespaceName", 
                                          "ServiceBusEntityName", // QueueName or TopicName or SubscriptionPath
                                          "SharedAccessSignatureKeyName", 
                                          "SharedAccessSignatureKey");
  
 String connectionString = connectionStringBuilder.toString();

接続文字列は、基本的に";" で区切られたキーと値のペアで構成される文字列です。 基本的な形式は {=[;=]} です。サポートされているキー名は次のとおりです。

• エンドポイント - servicebus 名前空間を指す URL
• EntityPath - Service Bus エンティティ (キュー/トピック/サブスクリプション/) へのパス。 キューとトピックの場合は、エンティティ名だけです。 サブスクリプションの場合、path は /subscriptions/ です。
• SharedAccessKeyName - 名前空間またはエンティティの対応する共有アクセス ポリシー規則のキー名。
• SharedAccessKey - 名前空間またはエンティティの対応する共有アクセス ポリシー規則のキー値。
• SharedAccessSignatureToken - キー名とキー値の代わりに、クライアントは既に生成された SAS トークンを提供できます。
• OperationTimeout - この接続文字列から作成されたすべての送信者、受信者、クライアントに使用される既定のタイムアウト。
• RetryPolicy - 再試行ポリシーの名前。

フィールドの概要

修飾子と型	フィールドと説明
static final Duration	DefaultOperationTimeout 接続文字列にタイムアウトが指定されていない場合の既定の操作タイムアウト。
static final String	MANAGED_IDENTITY_AUTHENTICATION_WITHOUT_SPACE 認証の目的でマネージド ID トークンプロバイダーが使用されることを示す [認証] フィールドに使用される接続文字列の値。
static final String	MANAGED_IDENTITY_AUTHENTICATION_WITH_SPACE

コンストラクターの概要

コンストラクター	説明
ConnectionStringBuilder(String connectionString)	指定された接続文字列から新しいインスタンスを作成します。
ConnectionStringBuilder(String namespaceConnectionString, String entityPath)	指定された接続文字列とエンティティ パスから新しいインスタンスを作成します。
ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessSingature)	名前空間、エンティティ パス、および既に生成された SAS トークンから新しいインスタンスを作成します。
ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessKeyName, String sharedAccessKey)	名前空間、エンティティ パス、SAS キーの名前と値から新しいインスタンスを作成します。
ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessSingature)	namesapce、エンティティ パス、および既に生成された SAS トークンのエンドポイント アドレスから新しいインスタンスを作成します。
ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessKeyName, String sharedAccessKey)	namesapce、エンティティ パス、SAS キーの名前と値のエンドポイント アドレスから新しいインスタンスを作成します

メソッドの概要

修飾子と型	メソッドと説明
String	getAuthentication()
URI	getEndpoint() ServiceBus 名前空間への接続に使用できるエンドポイントを取得します
String	getEntityPath() 接続文字列からエンティティ パスの値を取得する
Duration	getOperationTimeout() Send や RECEIVE などの保留中の操作がタイムアウトするまでの期間を取得します。
RetryPolicy	getRetryPolicy() このビルダーの作成の一部として作成された再試行ポリシー インスタンスを取得します。
String	getSasKey() 接続文字列または null から共有アクセス ポリシー キーの値を取得します。
String	getSasKeyName() 接続文字列または null から共有アクセス ポリシー所有者名を取得します。
String	getSharedAccessSignatureToken() 接続文字列または null から共有アクセス署名トークンを返します。
TransportType	getTransportType() この接続文字列を使用して Service Bus のすべての通信が作成されるトランスポートの種類。
void	setOperationTimeout(Duration operationTimeout) [接続文字列] で [操作タイムアウト] の値を設定します。
void	setRetryPolicy(RetryPolicy retryPolicy) 再試行ポリシーを設定します。
ConnectionStringBuilder	setTransportType(TransportType transportType) [接続文字列] で [トランスポートの種類] の値を設定します。
String	toLoggableString()
String	toString() ServiceBus 名前空間への接続に使用できる操作可能な接続文字列を返します。

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

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

フィールドの詳細

DefaultOperationTimeout

public static final Duration DefaultOperationTimeout

接続文字列にタイムアウトが指定されていない場合の既定の操作タイムアウト。 30 秒です。

MANAGED_IDENTITY_AUTHENTICATION_WITHOUT_SPACE

public static final String MANAGED_IDENTITY_AUTHENTICATION_WITHOUT_SPACE

[認証] フィールドに使用される接続文字列値。これは、マネージド ID TokenProvider が認証目的で使用されることを示します。

MANAGED_IDENTITY_AUTHENTICATION_WITH_SPACE

public static final String MANAGED_IDENTITY_AUTHENTICATION_WITH_SPACE

コンストラクターの詳細

ConnectionStringBuilder

public ConnectionStringBuilder(String connectionString)

指定された接続文字列から新しいインスタンスを作成します。 ConnectionString 形式: Endpoint=sb://namespace_DNS_Name;EntityPath=EVENT_HUB_NAME;SharedAccessKeyName=SHARED_ACCESS_KEY_NAME;SharedAccessKey=SHARED_ACCESS_KEY または Endpoint=sb://namespace_DNS_Name;EntityPath=EVENT_HUB_NAME;SharedAccessSignatureToken=SHARED_ACCESS_SIGNATURE_TOKEN

パラメーター:

connectionString - ServiceBus ConnectionString

ConnectionStringBuilder

public ConnectionStringBuilder(String namespaceConnectionString, String entityPath)

指定された接続文字列とエンティティ パスから新しいインスタンスを作成します。 接続文字列にエンティティ パスが含まれている場合と含まれていない場合があります。 ConnectionString 形式: Endpoint=sb://namespace_DNS_Name;EntityPath=EVENT_HUB_NAME;SharedAccessKeyName=SHARED_ACCESS_KEY_NAME;SharedAccessKey=SHARED_ACCESS_KEY または Endpoint=sb://namespace_DNS_Name;EntityPath=EVENT_HUB_NAME;SharedAccessSignatureToken=SHARED_ACCESS_SIGNATURE_TOKEN

パラメーター:

namespaceConnectionString - ServiceBus 名前空間の接続文字列。 これにはエンティティ パスは含まれません。

entityPath - 名前空間内のエンティティへのパス

ConnectionStringBuilder

public ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessSingature)

名前空間、エンティティ パス、および既に生成された SAS トークンから新しいインスタンスを作成します。

パラメーター:

namespaceName - 名前空間名 (dns サフィックス - 例: .servicebus.windows.net は必要ありません)

entityPath - エンティティ パス。 キューまたはトピックの場合は、名前を使用します。 サブスクリプションの場合は、topicName>/subscriptions/<subscriptionName を使用<します>

sharedAccessSingature - Shared Access Signature が既に生成されています

ConnectionStringBuilder

public ConnectionStringBuilder(String namespaceName, String entityPath, String sharedAccessKeyName, String sharedAccessKey)

名前空間、エンティティ パス、SAS キーの名前と値から新しいインスタンスを作成します。

パラメーター:

namespaceName - 名前空間名 (dns サフィックス - 例: .servicebus.windows.net は必要ありません)

entityPath - エンティティ パス。 キューまたはトピックの場合は、名前を使用します。 サブスクリプションの場合は、topicName>/subscriptions/<subscriptionName を使用<します>

sharedAccessKeyName - 共有アクセス キー名

sharedAccessKey - 共有アクセス キー

ConnectionStringBuilder

public ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessSingature)

namesapce、エンティティ パス、および既に生成された SAS トークンのエンドポイント アドレスから新しいインスタンスを作成します。

パラメーター:

endpointAddress - 名前空間レベルのエンドポイント。 これは、scheme://fullyQualifiedServiceBusNamespaceEndpointName の形式である必要があります

entityPath - エンティティ パス。 キューまたはトピックの場合は、名前を使用します。 サブスクリプションの場合は、topicName>/subscriptions/<subscriptionName を使用<します>

sharedAccessSingature - Shared Access Signature が既に生成されています

ConnectionStringBuilder

public ConnectionStringBuilder(URI endpointAddress, String entityPath, String sharedAccessKeyName, String sharedAccessKey)

namesapce、エンティティ パス、SAS キーの名前と値のエンドポイント アドレスから新しいインスタンスを作成します

パラメーター:

endpointAddress - 名前空間レベルのエンドポイント。 これは、scheme://fullyQualifiedServiceBusNamespaceEndpointName の形式である必要があります

entityPath - エンティティ パス。 キューまたはトピックの場合は、名前を使用します。 サブスクリプションの場合は、topicName>/subscriptions/<subscriptionName を使用<します>

sharedAccessKeyName - 共有アクセス キー名

sharedAccessKey - 共有アクセス キー

メソッドの詳細

getAuthentication

public String getAuthentication()

戻り値:

認証方法を返します。

getEndpoint

public URI getEndpoint()

ServiceBus 名前空間への接続に使用できるエンドポイントを取得します

戻り値:

Service Bus 名前空間を表すエンドポイント

getEntityPath

public String getEntityPath()

接続文字列からエンティティ パスの値を取得する

戻り値:

エンティティ パス

getOperationTimeout

public Duration getOperationTimeout()

Send や RECEIVE などの保留中の操作がタイムアウトするまでの期間を取得します。タイムアウトが指定されていない場合、明示的に過剰に DefaultOperationTimeout 取り込まれていない限り、この値は、この ConnectionStringBuilderを使用するすべての操作で使用されます。

戻り値:

operationTimeout

getRetryPolicy

public RetryPolicy getRetryPolicy()

このビルダーの作成の一部として作成された再試行ポリシー インスタンスを取得します。

戻り値:

この ConnectionString を使用して実行されたすべての操作に適用される RetryPolicy

getSasKey

public String getSasKey()

接続文字列または null から共有アクセス ポリシー キーの値を取得します。

戻り値:

Shared Access Signature キーの値

getSasKeyName

public String getSasKeyName()

接続文字列または null から共有アクセス ポリシー所有者名を取得します。

戻り値:

Shared Access Signature キー名

getSharedAccessSignatureToken

public String getSharedAccessSignatureToken()

接続文字列または null から共有アクセス署名トークンを返します。

戻り値:

Shared Access Signature Token

getTransportType

public TransportType getTransportType()

この ConnectionString を使用して Service Bus のすべての通信が作成される TransportType。 既定値は AMQP です。

戻り値:

transportType

setOperationTimeout

public void setOperationTimeout(Duration operationTimeout)

接続文字列で OperationTimeout 値を設定します。 この値は、明示的に過剰に取り込まれていない限り、この ConnectionStringBuilderを使用するすべての操作で使用されます。

operationTimeout を含む ConnectionString は、java と他のプラットフォームのクライアント間で操作できません。

パラメーター:

operationTimeout - 操作のタイムアウト

setRetryPolicy

public void setRetryPolicy(RetryPolicy retryPolicy)

再試行ポリシーを設定します。

RetryPolicy は の一部としてシリアル化されず、他の toString() プラットフォームの ServiceBus クライアントと相互運用できません。

パラメーター:

retryPolicy - この ConnectionString を使用して実行されたすべての操作に適用される RetryPolicy

setTransportType

public ConnectionStringBuilder setTransportType(TransportType transportType)

接続文字列で TransportType 値を設定します。 TransportType が設定されていない場合、既定値は になります AMQP。

パラメーター:

transportType - トランスポートの種類

戻り値:

設定 ConnectionStringBuilder されているインスタンス。

toLoggableString

public String toLoggableString()

toString

public String toString()

ServiceBus 名前空間への接続に使用できる操作可能な接続文字列を返します。

上書き:

ConnectionStringBuilder.toString()

戻り値:

接続文字列 (connection string)