com.microsoft.azure.eventhubs.ConnectionStringBuilder Maven / Gradle / Ivy
/*
* Copyright (c) Microsoft. All rights reserved.
* Licensed under the MIT license. See LICENSE file in the project root for full license information.
*/
package com.microsoft.azure.eventhubs;
import java.net.URI;
import java.net.URISyntaxException;
import java.time.Duration;
import java.time.format.DateTimeParseException;
import java.util.Locale;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* {@link ConnectionStringBuilder} can be used to construct a connection string which can establish communication with ServiceBus entities.
* It can also be used to perform basic validation on an existing connection string.
* Sample Code:
*
{@code
* ConnectionStringBuilder connectionStringBuilder = new ConnectionStringBuilder(
* "ServiceBusNamespaceName",
* "ServiceBusEntityName", // eventHubName or QueueName or TopicName
* "SharedAccessSignatureKeyName",
* "SharedAccessSignatureKey");
*
* String connectionString = connectionStringBuilder.toString();
* }
*
* A connection string is basically a string consisted of key-value pair separated by ";".
* Basic format is {{@literal <}key{@literal >}={@literal <}value{@literal >}[;{@literal <}key{@literal >}={@literal <}value{@literal >}]} where supported key name are as follow:
*
* - Endpoint - the URL that contains the servicebus namespace
*
- EntityPath - the path to the service bus entity (queue/topic/eventhub/subscription/consumergroup/partition)
*
- SharedAccessKeyName - the key name to the corresponding shared access policy rule for the namespace, or entity.
*
- SharedAccessKey - the key for the corresponding shared access policy rule of the namespace or entity.
*
*/
public class ConnectionStringBuilder {
final static String endpointFormat = "amqps://%s.servicebus.windows.net";
final static String endpointRawFormat = "amqps://%s";
final static String HostnameConfigName = "Hostname";
final static String EndpointConfigName = "Endpoint";
final static String SharedAccessKeyNameConfigName = "SharedAccessKeyName";
final static String SharedAccessKeyConfigName = "SharedAccessKey";
final static String SharedAccessSignatureConfigName = "SharedAccessSignature";
final static String EntityPathConfigName = "EntityPath";
final static String OperationTimeoutConfigName = "OperationTimeout";
final static String RetryPolicyConfigName = "RetryPolicy";
final static String KeyValueSeparator = "=";
final static String KeyValuePairDelimiter = ";";
private static final String AllKeyEnumerateRegex = "(" + HostnameConfigName + "|" + EndpointConfigName + "|" + SharedAccessKeyNameConfigName
+ "|" + SharedAccessKeyConfigName + "|" + SharedAccessSignatureConfigName + "|" + EntityPathConfigName + "|" + OperationTimeoutConfigName
+ "|" + RetryPolicyConfigName + ")";
private static final String KeysWithDelimitersRegex = KeyValuePairDelimiter + AllKeyEnumerateRegex
+ KeyValueSeparator;
private URI endpoint;
private String sharedAccessKeyName;
private String sharedAccessKey;
private String entityPath;
private String sharedAccessSignature;
private Duration operationTimeout;
private RetryPolicy retryPolicy;
private ConnectionStringBuilder(
final URI endpointAddress,
final String entityPath,
final String sharedAccessKeyName,
final String sharedAccessKey,
final Duration operationTimeout,
final RetryPolicy retryPolicy) {
this.endpoint = endpointAddress;
this.sharedAccessKey = sharedAccessKey;
this.sharedAccessKeyName = sharedAccessKeyName;
this.operationTimeout = operationTimeout;
this.retryPolicy = retryPolicy;
this.entityPath = entityPath;
}
private ConnectionStringBuilder(
final URI endpointAddress,
final String entityPath,
final String sharedAccessSignature,
final Duration operationTimeout,
final RetryPolicy retryPolicy) {
this.endpoint = endpointAddress;
this.sharedAccessSignature = sharedAccessSignature;
this.operationTimeout = operationTimeout;
this.retryPolicy = retryPolicy;
this.entityPath = entityPath;
}
private ConnectionStringBuilder(
final String namespaceName,
final String entityPath,
final String sharedAccessKeyName,
final String sharedAccessKey,
final Duration operationTimeout,
final RetryPolicy retryPolicy) {
try {
this.endpoint = new URI(String.format(Locale.US, endpointFormat, namespaceName));
} catch (URISyntaxException exception) {
throw new IllegalConnectionStringFormatException(
String.format(Locale.US, "Invalid namespace name: %s", namespaceName),
exception);
}
this.sharedAccessKey = sharedAccessKey;
this.sharedAccessKeyName = sharedAccessKeyName;
this.operationTimeout = operationTimeout;
this.retryPolicy = retryPolicy;
this.entityPath = entityPath;
}
/**
* Build a connection string consumable by {@link com.microsoft.azure.eventhubs.EventHubClient#createFromConnectionString(String)}
*
* @param namespaceName Namespace name (dns suffix - ex: .servicebus.windows.net is not required)
* @param entityPath Entity path. For eventHubs case specify - eventHub name.
* @param sharedAccessKeyName Shared Access Key name
* @param sharedAccessKey Shared Access Key
*/
public ConnectionStringBuilder(
final String namespaceName,
final String entityPath,
final String sharedAccessKeyName,
final String sharedAccessKey) {
this(namespaceName, entityPath, sharedAccessKeyName, sharedAccessKey, MessagingFactory.DefaultOperationTimeout, RetryPolicy.getDefault());
}
/**
* Build a connection string consumable by {@link com.microsoft.azure.eventhubs.EventHubClient#createFromConnectionString(String)}
*
* @param endpointAddress namespace level endpoint. This needs to be in the format of scheme://fullyQualifiedServiceBusNamespaceEndpointName
* @param entityPath Entity path. For eventHubs case specify - eventHub name.
* @param sharedAccessKeyName Shared Access Key name
* @param sharedAccessKey Shared Access Key
*/
public ConnectionStringBuilder(
final URI endpointAddress,
final String entityPath,
final String sharedAccessKeyName,
final String sharedAccessKey) {
this(endpointAddress, entityPath, sharedAccessKeyName, sharedAccessKey, MessagingFactory.DefaultOperationTimeout, RetryPolicy.getDefault());
}
/**
* Build a connection string consumable by {@link com.microsoft.azure.eventhubs.EventHubClient#createFromConnectionString(String)}
*
* @param endpointAddress namespace level endpoint. This needs to be in the format of scheme://fullyQualifiedServiceBusNamespaceEndpointName
* @param entityPath Entity path. For eventHubs case specify - eventHub name.
* @param sharedAccessSignature Shared Access Signature
*/
public ConnectionStringBuilder(
final URI endpointAddress,
final String entityPath,
final String sharedAccessSignature) {
this(endpointAddress, entityPath, sharedAccessSignature, MessagingFactory.DefaultOperationTimeout, RetryPolicy.getDefault());
}
/**
* ConnectionString format:
* Endpoint=sb://namespace_DNS_Name;EntityPath=EVENT_HUB_NAME;SharedAccessKeyName=SHARED_ACCESS_KEY_NAME;SharedAccessKey=SHARED_ACCESS_KEY
*
* @param connectionString ServiceBus ConnectionString
* @throws IllegalConnectionStringFormatException when the format of the ConnectionString is not valid
*/
public ConnectionStringBuilder(String connectionString) {
this.parseConnectionString(connectionString);
}
/**
* Get the endpoint which can be used to connect to the ServiceBus Namespace
*
* @return Endpoint
*/
public URI getEndpoint() {
return this.endpoint;
}
/**
* Get the shared access policy key value from the connection string
*
* @return Shared Access Signature key
*/
public String getSasKey() {
return this.sharedAccessKey;
}
/**
* Get the shared access policy owner name from the connection string
*
* @return Shared Access Signature key name.
*/
public String getSasKeyName() {
return this.sharedAccessKeyName;
}
/**
* Get the shared access signature (also referred as SAS Token) from the connection string
*
* @return Shared Access Signature
*/
public String getSharedAccessSignature() {
return this.sharedAccessSignature;
}
/**
* Get the entity path value from the connection string
*
* @return Entity Path
*/
public String getEntityPath() {
return this.entityPath;
}
/**
* OperationTimeout is applied in erroneous situations to notify the caller about the relevant {@link EventHubException}
*
* @return operationTimeout
*/
public Duration getOperationTimeout() {
return (this.operationTimeout == null ? MessagingFactory.DefaultOperationTimeout : this.operationTimeout);
}
/**
* Set the OperationTimeout value in the Connection String. This value will be used by all operations which uses this {@link ConnectionStringBuilder}, unless explicitly over-ridden.
* ConnectionString with operationTimeout is not inter-operable between java and clients in other platforms.
*
* @param operationTimeout Operation Timeout
*/
public void setOperationTimeout(final Duration operationTimeout) {
this.operationTimeout = operationTimeout;
}
/**
* Get the retry policy instance that was created as part of this builder's creation.
*
* @return RetryPolicy applied for any operation performed using this ConnectionString
*/
@Deprecated
public RetryPolicy getRetryPolicy() {
return (this.retryPolicy == null ? RetryPolicy.getDefault() : this.retryPolicy);
}
/**
* Set the retry policy.
*
RetryPolicy is not inter-operable with ServiceBus clients in other platforms.
*
* @param retryPolicy RetryPolicy applied for any operation performed using this ConnectionString
*/
@Deprecated
public void setRetryPolicy(final RetryPolicy retryPolicy) {
this.retryPolicy = retryPolicy;
}
/**
* Returns an inter-operable connection string that can be used to connect to ServiceBus Namespace
*
* @return connection string
*/
@Override
public String toString() {
final StringBuilder connectionStringBuilder = new StringBuilder();
if (this.endpoint != null) {
connectionStringBuilder.append(String.format(Locale.US, "%s%s%s%s", EndpointConfigName, KeyValueSeparator,
this.endpoint.toString(), KeyValuePairDelimiter));
}
if (!StringUtil.isNullOrWhiteSpace(this.entityPath)) {
connectionStringBuilder.append(String.format(Locale.US, "%s%s%s%s", EntityPathConfigName,
KeyValueSeparator, this.entityPath, KeyValuePairDelimiter));
}
if (!StringUtil.isNullOrWhiteSpace(this.sharedAccessKeyName)) {
connectionStringBuilder.append(String.format(Locale.US, "%s%s%s%s", SharedAccessKeyNameConfigName,
KeyValueSeparator, this.sharedAccessKeyName, KeyValuePairDelimiter));
}
if (!StringUtil.isNullOrWhiteSpace(this.sharedAccessKey)) {
connectionStringBuilder.append(String.format(Locale.US, "%s%s%s%s", SharedAccessKeyConfigName,
KeyValueSeparator, this.sharedAccessKey, KeyValuePairDelimiter));
}
if (!StringUtil.isNullOrWhiteSpace(this.sharedAccessSignature)) {
connectionStringBuilder.append(String.format(Locale.US, "%s%s%s%s", SharedAccessSignatureConfigName,
KeyValueSeparator, this.sharedAccessSignature, KeyValuePairDelimiter));
}
if (this.operationTimeout != null) {
connectionStringBuilder.append(String.format(Locale.US, "%s%s%s%s", OperationTimeoutConfigName,
KeyValueSeparator, this.operationTimeout.toString(), KeyValuePairDelimiter));
}
if (this.retryPolicy != null) {
connectionStringBuilder.append(String.format(Locale.US, "%s%s%s%s", RetryPolicyConfigName,
KeyValueSeparator, this.retryPolicy.toString(), KeyValuePairDelimiter));
}
connectionStringBuilder.deleteCharAt(connectionStringBuilder.length() - 1);
return connectionStringBuilder.toString();
}
private void parseConnectionString(final String connectionString) {
if (StringUtil.isNullOrWhiteSpace(connectionString)) {
throw new IllegalConnectionStringFormatException(String.format("connectionString cannot be empty"));
}
final String connection = KeyValuePairDelimiter + connectionString;
final Pattern keyValuePattern = Pattern.compile(KeysWithDelimitersRegex, Pattern.CASE_INSENSITIVE);
final String[] values = keyValuePattern.split(connection);
final Matcher keys = keyValuePattern.matcher(connection);
if (values == null || values.length <= 1 || keys.groupCount() == 0) {
throw new IllegalConnectionStringFormatException("Connection String cannot be parsed.");
}
if (!StringUtil.isNullOrWhiteSpace((values[0]))) {
throw new IllegalConnectionStringFormatException(
String.format(Locale.US, "Cannot parse part of ConnectionString: %s", values[0]));
}
int valueIndex = 0;
while (keys.find()) {
valueIndex++;
String key = keys.group();
key = key.substring(1, key.length() - 1);
if (values.length < valueIndex + 1) {
throw new IllegalConnectionStringFormatException(
String.format(Locale.US, "Value for the connection string parameter name: %s, not found", key));
}
if (key.equalsIgnoreCase(EndpointConfigName)) {
if (this.endpoint != null) {
// we have parsed the endpoint once, which means we have multiple config which is not allowed
throw new IllegalConnectionStringFormatException(
String.format(Locale.US, "Multiple %s and/or %s detected. Make sure only one is defined", EndpointConfigName, HostnameConfigName));
}
try {
this.endpoint = new URI(values[valueIndex]);
} catch (URISyntaxException exception) {
throw new IllegalConnectionStringFormatException(
String.format(Locale.US, "%s should be in format scheme://fullyQualifiedServiceBusNamespaceEndpointName", EndpointConfigName),
exception);
}
} else if (key.equalsIgnoreCase(HostnameConfigName)) {
if (this.endpoint != null) {
// we have parsed the endpoint once, which means we have multiple config which is not allowed
throw new IllegalConnectionStringFormatException(
String.format(Locale.US, "Multiple %s and/or %s detected. Make sure only one is defined", EndpointConfigName, HostnameConfigName));
}
try {
this.endpoint = new URI(String.format(Locale.US, endpointRawFormat, values[valueIndex]));
} catch (URISyntaxException exception) {
throw new IllegalConnectionStringFormatException(
String.format(Locale.US, "%s should be a fully quantified host name address", HostnameConfigName),
exception);
}
} else if (key.equalsIgnoreCase(SharedAccessKeyNameConfigName)) {
this.sharedAccessKeyName = values[valueIndex];
} else if (key.equalsIgnoreCase(SharedAccessKeyConfigName)) {
this.sharedAccessKey = values[valueIndex];
} else if (key.equalsIgnoreCase(SharedAccessSignatureConfigName)) {
this.sharedAccessSignature = values[valueIndex];
} else if (key.equalsIgnoreCase(EntityPathConfigName)) {
this.entityPath = values[valueIndex];
} else if (key.equalsIgnoreCase(OperationTimeoutConfigName)) {
try {
this.operationTimeout = Duration.parse(values[valueIndex]);
} catch (DateTimeParseException exception) {
throw new IllegalConnectionStringFormatException("Invalid value specified for property 'Duration' in the ConnectionString.", exception);
}
} else if (key.equalsIgnoreCase(RetryPolicyConfigName)) {
this.retryPolicy = values[valueIndex].equals(ClientConstants.DEFAULT_RETRY)
? RetryPolicy.getDefault()
: (values[valueIndex].equals(ClientConstants.NO_RETRY) ? RetryPolicy.getNoRetry() : null);
if (this.retryPolicy == null)
throw new IllegalConnectionStringFormatException(
String.format(Locale.US, "Connection string parameter '%s'='%s' is not recognized",
RetryPolicyConfigName, values[valueIndex]));
} else {
throw new IllegalConnectionStringFormatException(
String.format(Locale.US, "Illegal connection string parameter name: %s", key));
}
}
}
}