com.microsoft.azure.eventhubs.ConnectionStringBuilder Maven / Gradle / Ivy
Show all versions of azure-eventhubs Show documentation
// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
package com.microsoft.azure.eventhubs;
import com.microsoft.azure.eventhubs.impl.MessagingFactory;
import com.microsoft.azure.eventhubs.impl.StringUtil;
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 Event Hub instances.
* In addition to constructing a connection string, the {@link ConnectionStringBuilder} can be used to modify an existing connection string.
* Sample Code:
*
{@code
* // Construct a new connection string
* ConnectionStringBuilder connectionStringBuilder = new ConnectionStringBuilder()
* .setNamespaceName("EventHubsNamespaceName")
* .setEventHubName("EventHubsEntityName")
* .setSasKeyName("SharedAccessSignatureKeyName")
* .setSasKey("SharedAccessSignatureKey")
*
* string connString = connectionStringBuilder.build();
*
* // Modify an existing connection string
* ConnectionStringBuilder connectionStringBuilder = new ConnectionStringBuilder(existingConnectionString)
* .setEventHubName("SomeOtherEventHubsName")
* .setOperationTimeout(Duration.ofSeconds(30)
*
* string connString = connectionStringBuilder.build();
* }
*
* A connection string is basically a string consisting of key-value pairs separated by ";".
* The 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 EventHubs namespace
*
- EntityPath - the EventHub name which you are connecting to
*
- 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 final class ConnectionStringBuilder {
static final String END_POINT_FORMAT = "sb://%s.%s";
static final String HOST_NAME_FORMAT = "sb://%s";
static final String DEFAULT_DOMAIN_NAME = "servicebus.windows.net";
static final String HOST_NAME_CONFIG_NAME = "Hostname"; // Hostname is a key that is used in IoTHub.
static final String ENDPOINT_CONFIG_NAME = "Endpoint"; // Endpoint key is used in EventHubs. It's identical to Hostname in IoTHub.
static final String ENTITY_PATH_CONFIG_NAME = "EntityPath";
static final String OPERATION_TIMEOUT_CONFIG_NAME = "OperationTimeout";
static final String KEY_VALUE_SEPARATOR = "=";
static final String KEY_VALUE_PAIR_DELIMITER = ";";
static final String SHARED_ACCESS_KEY_NANE_CONFIG_NAME = "SharedAccessKeyName"; // We use a (KeyName, Key) pair OR the SAS token - never both.
static final String SHARED_ACCESS_KEY_CONFIG_NAME = "SharedAccessKey";
static final String SHARED_ACCESS_SIGNATURE_CONFIG_NAME = "SharedAccessSignature";
static final String TRANSPORT_TYPE_CONFIG_NAME = "TransportType";
static final String AUTHENTICATION_CONFIG_NAME = "Authentication";
public static final String MANAGED_IDENTITY_AUTHENTICATION = "Managed Identity";
private static final String ALL_KEY_ENUMERATE_REGEX = "(" + HOST_NAME_CONFIG_NAME + "|" + ENDPOINT_CONFIG_NAME + "|" + SHARED_ACCESS_KEY_NANE_CONFIG_NAME
+ "|" + SHARED_ACCESS_KEY_CONFIG_NAME + "|" + SHARED_ACCESS_SIGNATURE_CONFIG_NAME + "|" + ENTITY_PATH_CONFIG_NAME + "|" + OPERATION_TIMEOUT_CONFIG_NAME
+ "|" + TRANSPORT_TYPE_CONFIG_NAME + "|" + AUTHENTICATION_CONFIG_NAME + ")";
private static final String KEYS_WITH_DELIMITERS_REGEX = KEY_VALUE_PAIR_DELIMITER + ALL_KEY_ENUMERATE_REGEX
+ KEY_VALUE_SEPARATOR;
private URI endpoint;
private String eventHubName;
private String sharedAccessKeyName;
private String sharedAccessKey;
private String sharedAccessSignature;
private Duration operationTimeout;
private TransportType transportType;
private String authentication;
/**
* Creates an empty {@link ConnectionStringBuilder}. At minimum, a namespace name, an entity path, SAS key name, and SAS key
* need to be set before a valid connection string can be built.
*
* For advanced users, the following replacements can be done:
*
* - An endpoint can be provided instead of a namespace name.
* - A SAS token can be provided instead of a SAS key name and SAS key.
* - Optionally, users can set an operation timeout instead of using the default value.
*
*/
public ConnectionStringBuilder() {
}
/**
* ConnectionString format:
* Endpoint=sb://namespace_DNS_Name;EntityPath=EVENT_HUB_NAME;SharedAccessKeyName=SHARED_ACCESS_KEY_NAME;SharedAccessKey=SHARED_ACCESS_KEY
*
* @param connectionString EventHubs ConnectionString
* @throws IllegalConnectionStringFormatException when the format of the ConnectionString is not valid
*/
public ConnectionStringBuilder(String connectionString) {
parseConnectionString(connectionString);
}
/**
* Get the endpoint which can be used to connect to the EventHub instance.
*
* @return The currently set endpoint
*/
public URI getEndpoint() {
return this.endpoint;
}
/**
* Set an endpoint which can be used to connect to the EventHub instance.
*
* @param endpoint is a combination of the namespace name and domain name. Together, these pieces make a valid
* endpoint. For example, the default domain name is "servicebus.windows.net", so a sample endpoint
* would look like this: "sb://namespace_name.servicebus.windows.net".
* @return the {@link ConnectionStringBuilder} being set.
*/
public ConnectionStringBuilder setEndpoint(URI endpoint) {
this.endpoint = endpoint;
return this;
}
/**
* Set an endpoint which can be used to connect to the EventHub instance.
*
* @param namespaceName the name of the namespace to connect to.
* @param domainName identifies the domain the namespace is located in. For non-public and national clouds,
* the domain will not be "servicebus.windows.net". Available options include:
* - "servicebus.usgovcloudapi.net"
* - "servicebus.cloudapi.de"
* - "servicebus.chinacloudapi.cn"
* @return the {@link ConnectionStringBuilder} being set.
*/
public ConnectionStringBuilder setEndpoint(String namespaceName, String domainName) {
try {
this.endpoint = new URI(String.format(Locale.US, END_POINT_FORMAT, namespaceName, domainName));
} catch (URISyntaxException exception) {
throw new IllegalConnectionStringFormatException(
String.format(Locale.US, "Invalid namespace name: %s", namespaceName),
exception);
}
return this;
}
/**
* Set a namespace name which will be used to connect to an EventHubs instance. This method adds
* "servicebus.windows.net" as the default domain name.
*
* @param namespaceName the name of the namespace to connect to.
* @return the {@link ConnectionStringBuilder} being set.
*/
public ConnectionStringBuilder setNamespaceName(String namespaceName) {
return this.setEndpoint(namespaceName, DEFAULT_DOMAIN_NAME);
}
/**
* Get the entity path value from the connection string.
*
* @return Entity Path
*/
public String getEventHubName() {
return this.eventHubName;
}
/**
* Set the entity path value from the connection string.
*
* @param eventHubName the name of the Event Hub to connect to.
* @return the {@link ConnectionStringBuilder} being set.
*/
public ConnectionStringBuilder setEventHubName(String eventHubName) {
this.eventHubName = eventHubName;
return this;
}
/**
* Get the shared access policy key value from the connection string
*
* @return Shared Access Signature key
*/
public String getSasKey() {
return this.sharedAccessKey;
}
/**
* Set the shared access policy key value from the connection string
*
* @param sasKey the SAS key
* @return the {@link ConnectionStringBuilder} being set.
*/
public ConnectionStringBuilder setSasKey(String sasKey) {
this.sharedAccessKey = sasKey;
return this;
}
/**
* Get the shared access policy owner name from the connection string
*
* @return Shared Access Signature key name.
*/
public String getSasKeyName() {
return this.sharedAccessKeyName;
}
/**
* Set the shared access policy owner name from the connection string
*
* @param sasKeyName the SAS key name
* @return the {@link ConnectionStringBuilder} being set.
*/
public ConnectionStringBuilder setSasKeyName(String sasKeyName) {
this.sharedAccessKeyName = sasKeyName;
return this;
}
/**
* Get the shared access signature (also referred as SAS Token) from the connection string
*
* @return Shared Access Signature
*/
public String getSharedAccessSignature() {
return this.sharedAccessSignature;
}
/**
* Set the shared access signature (also referred as SAS Token) from the connection string
*
* @param sharedAccessSignature the shared access key signature
* @return the {@link ConnectionStringBuilder} being set.
*/
public ConnectionStringBuilder setSharedAccessSignature(String sharedAccessSignature) {
this.sharedAccessSignature = sharedAccessSignature;
return this;
}
/**
* 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
* @return the {@link ConnectionStringBuilder} being set.
*/
public ConnectionStringBuilder setOperationTimeout(final Duration operationTimeout) {
this.operationTimeout = operationTimeout;
return this;
}
/**
* TransportType on which all the communication for the EventHub objects created using this ConnectionString.
* Default value is {@link TransportType#AMQP}.
*
* @return transportType
*/
public TransportType getTransportType() {
return (this.transportType == null ? TransportType.AMQP : transportType);
}
/**
* Set the TransportType value in the Connection String. If no TransportType is set, this defaults to {@link TransportType#AMQP}.
*
* @param transportType Transport Type
* @return the {@link ConnectionStringBuilder} instance being set.
*/
public ConnectionStringBuilder setTransportType(final TransportType transportType) {
this.transportType = transportType;
return this;
}
/**
* Get the authentication type in the Connection String.
*
* @return authentication
*/
public String getAuthentication() {
return this.authentication;
}
/**
* Set the authentication type in the Connection String. The only valid values are "Managed Identity" or null.
*
* @param authentication
* @return the {@link ConnectionStringBuilder} instance being set.
*/
public ConnectionStringBuilder setAuthentication(final String authentication) {
this.authentication = authentication;
return this;
}
/**
* Returns an inter-operable connection string that can be used to connect to EventHubs instances.
*
* @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", ENDPOINT_CONFIG_NAME, KEY_VALUE_SEPARATOR,
this.endpoint.toString(), KEY_VALUE_PAIR_DELIMITER));
}
if (!StringUtil.isNullOrWhiteSpace(this.eventHubName)) {
connectionStringBuilder.append(String.format(Locale.US, "%s%s%s%s", ENTITY_PATH_CONFIG_NAME,
KEY_VALUE_SEPARATOR, this.eventHubName, KEY_VALUE_PAIR_DELIMITER));
}
if (!StringUtil.isNullOrWhiteSpace(this.sharedAccessKeyName)) {
connectionStringBuilder.append(String.format(Locale.US, "%s%s%s%s", SHARED_ACCESS_KEY_NANE_CONFIG_NAME,
KEY_VALUE_SEPARATOR, this.sharedAccessKeyName, KEY_VALUE_PAIR_DELIMITER));
}
if (!StringUtil.isNullOrWhiteSpace(this.sharedAccessKey)) {
connectionStringBuilder.append(String.format(Locale.US, "%s%s%s%s", SHARED_ACCESS_KEY_CONFIG_NAME,
KEY_VALUE_SEPARATOR, this.sharedAccessKey, KEY_VALUE_PAIR_DELIMITER));
}
if (!StringUtil.isNullOrWhiteSpace(this.sharedAccessSignature)) {
connectionStringBuilder.append(String.format(Locale.US, "%s%s%s%s", SHARED_ACCESS_SIGNATURE_CONFIG_NAME,
KEY_VALUE_SEPARATOR, this.sharedAccessSignature, KEY_VALUE_PAIR_DELIMITER));
}
if (this.operationTimeout != null) {
connectionStringBuilder.append(String.format(Locale.US, "%s%s%s%s", OPERATION_TIMEOUT_CONFIG_NAME,
KEY_VALUE_SEPARATOR, this.operationTimeout.toString(), KEY_VALUE_PAIR_DELIMITER));
}
if (this.transportType != null) {
connectionStringBuilder.append(String.format(Locale.US, "%s%s%s%s", TRANSPORT_TYPE_CONFIG_NAME,
KEY_VALUE_SEPARATOR, this.transportType.toString(), KEY_VALUE_PAIR_DELIMITER));
}
if (!StringUtil.isNullOrWhiteSpace(this.authentication)) {
connectionStringBuilder.append(String.format(Locale.US, "%s%s%s%s", AUTHENTICATION_CONFIG_NAME,
KEY_VALUE_SEPARATOR, this.authentication, KEY_VALUE_PAIR_DELIMITER));
}
connectionStringBuilder.deleteCharAt(connectionStringBuilder.length() - 1);
return connectionStringBuilder.toString();
}
private void parseConnectionString(final String connectionString) {
if (StringUtil.isNullOrWhiteSpace(connectionString)) {
throw new IllegalConnectionStringFormatException("connectionString cannot be empty");
}
final String connection = KEY_VALUE_PAIR_DELIMITER + connectionString;
final Pattern keyValuePattern = Pattern.compile(KEYS_WITH_DELIMITERS_REGEX, 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(ENDPOINT_CONFIG_NAME)) {
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", ENDPOINT_CONFIG_NAME, HOST_NAME_CONFIG_NAME));
}
try {
this.endpoint = new URI(values[valueIndex]);
} catch (URISyntaxException exception) {
throw new IllegalConnectionStringFormatException(
String.format(Locale.US, "%s should be in format scheme://fullyQualifiedServiceBusNamespaceEndpointName", ENDPOINT_CONFIG_NAME),
exception);
}
} else if (key.equalsIgnoreCase(HOST_NAME_CONFIG_NAME)) {
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", ENDPOINT_CONFIG_NAME, HOST_NAME_CONFIG_NAME));
}
try {
this.endpoint = new URI(String.format(Locale.US, HOST_NAME_FORMAT, values[valueIndex]));
} catch (URISyntaxException exception) {
throw new IllegalConnectionStringFormatException(
String.format(Locale.US, "%s should be a fully quantified host name address", HOST_NAME_CONFIG_NAME),
exception);
}
} else if (key.equalsIgnoreCase(SHARED_ACCESS_KEY_NANE_CONFIG_NAME)) {
this.sharedAccessKeyName = values[valueIndex];
} else if (key.equalsIgnoreCase(SHARED_ACCESS_KEY_CONFIG_NAME)) {
this.sharedAccessKey = values[valueIndex];
} else if (key.equalsIgnoreCase(SHARED_ACCESS_SIGNATURE_CONFIG_NAME)) {
this.sharedAccessSignature = values[valueIndex];
} else if (key.equalsIgnoreCase(ENTITY_PATH_CONFIG_NAME)) {
this.eventHubName = values[valueIndex];
} else if (key.equalsIgnoreCase(OPERATION_TIMEOUT_CONFIG_NAME)) {
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(TRANSPORT_TYPE_CONFIG_NAME)) {
try {
this.transportType = TransportType.fromString(values[valueIndex]);
} catch (IllegalArgumentException exception) {
throw new IllegalConnectionStringFormatException(
String.format(Locale.US, "Invalid value specified for property '%s' in the ConnectionString.", TRANSPORT_TYPE_CONFIG_NAME),
exception);
}
} else if (key.equalsIgnoreCase(AUTHENTICATION_CONFIG_NAME)) {
this.authentication = values[valueIndex];
} else {
throw new IllegalConnectionStringFormatException(
String.format(Locale.US, "Illegal connection string parameter name: %s", key));
}
}
}
}