Skip to content

Commit

Permalink
[Service Bus Client] Add Parser, Hide Shared Key Credential (Azure#16426
Browse files Browse the repository at this point in the history 
)

The focus of these changes is to add the connection string parser to the
public API surface, while hiding the shared key credential.  The credential
types will be retired when the concept is added to Azure.Core, and the
client constructors are converted over to the shared types.
  • Loading branch information
@jsquire @annelo-msft
jsquire authored and annelo-msft committed Feb 17, 2021
1 parent 029ea8d commit 4c2f837
Show file tree
Hide file tree
Showing 29 changed files with 1,502 additions and 900 deletions.
6 changes: 6 additions & 0 deletions sdk/servicebus/Azure.Messaging.ServiceBus/Azure.Messaging.ServiceBus.sln
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Core.Experimental", "
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Core", "..\..\core\Azure.Core\src\Azure.Core.csproj", "{9CD1905A-19B9-4F71-8BE6-D25CF49DA5B3}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Core.Amqp", "..\..\core\Azure.Core.Amqp\src\Azure.Core.Amqp.csproj", "{2ADA26CA-77E5-4793-927A-A6185FD8AA29}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand All @@ -59,6 +61,10 @@ Global
{9CD1905A-19B9-4F71-8BE6-D25CF49DA5B3}.Debug|Any CPU.Build.0 = Debug|Any CPU
{9CD1905A-19B9-4F71-8BE6-D25CF49DA5B3}.Release|Any CPU.ActiveCfg = Release|Any CPU
{9CD1905A-19B9-4F71-8BE6-D25CF49DA5B3}.Release|Any CPU.Build.0 = Release|Any CPU
{2ADA26CA-77E5-4793-927A-A6185FD8AA29}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{2ADA26CA-77E5-4793-927A-A6185FD8AA29}.Debug|Any CPU.Build.0 = Debug|Any CPU
{2ADA26CA-77E5-4793-927A-A6185FD8AA29}.Release|Any CPU.ActiveCfg = Release|Any CPU
{2ADA26CA-77E5-4793-927A-A6185FD8AA29}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down
37 changes: 17 additions & 20 deletions sdk/servicebus/Azure.Messaging.ServiceBus/api/Azure.Messaging.ServiceBus.netstandard2.0.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,6 @@ public ServiceBusClient(string connectionString) { }
public ServiceBusClient(string fullyQualifiedNamespace, Azure.Core.TokenCredential credential) { }
public ServiceBusClient(string fullyQualifiedNamespace, Azure.Core.TokenCredential credential, Azure.Messaging.ServiceBus.ServiceBusClientOptions options) { }
public ServiceBusClient(string connectionString, Azure.Messaging.ServiceBus.ServiceBusClientOptions options) { }
public ServiceBusClient(string fullyQualifiedNamespace, Azure.Messaging.ServiceBus.ServiceBusSharedAccessKeyCredential credential) { }
public ServiceBusClient(string fullyQualifiedNamespace, Azure.Messaging.ServiceBus.ServiceBusSharedAccessKeyCredential credential, Azure.Messaging.ServiceBus.ServiceBusClientOptions options) { }
public string FullyQualifiedNamespace { get { throw null; } }
public bool IsClosed { get { throw null; } }
public Azure.Messaging.ServiceBus.ServiceBusTransportType TransportType { get { throw null; } }
Expand Down Expand Up @@ -106,6 +104,23 @@ public ServiceBusClientOptions() { }
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
public override string ToString() { throw null; }
}
public partial class ServiceBusConnectionStringProperties
{
public ServiceBusConnectionStringProperties() { }
public System.Uri Endpoint { get { throw null; } }
public string EntityPath { get { throw null; } }
public string FullyQualifiedNamespace { get { throw null; } }
public string SharedAccessKey { get { throw null; } }
public string SharedAccessKeyName { get { throw null; } }
public string SharedAccessSignature { get { throw null; } }
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
public override bool Equals(object obj) { throw null; }
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
public override int GetHashCode() { throw null; }
public static Azure.Messaging.ServiceBus.ServiceBusConnectionStringProperties Parse(string connectionString) { throw null; }
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
public override string ToString() { throw null; }
}
public enum ServiceBusErrorSource
{
Complete = 0,
Expand Down Expand Up @@ -432,22 +447,6 @@ public ServiceBusSessionReceiverOptions() { }
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
public override string ToString() { throw null; }
}
public sealed partial class ServiceBusSharedAccessKeyCredential
{
public ServiceBusSharedAccessKeyCredential(string sharedAccessSignature) { }
public ServiceBusSharedAccessKeyCredential(string sharedAccessKeyName, string sharedAccessKey) { }
public string SharedAccessKey { get { throw null; } }
public string SharedAccessKeyName { get { throw null; } }
public string SharedAccessSignature { get { throw null; } }
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
public override bool Equals(object obj) { throw null; }
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
public override int GetHashCode() { throw null; }
[System.ComponentModel.EditorBrowsableAttribute(System.ComponentModel.EditorBrowsableState.Never)]
public override string ToString() { throw null; }
public void UpdateSharedAccessKey(string keyName, string keyValue) { }
public void UpdateSharedAccessSignature(string sharedAccessSignature) { }
}
public enum ServiceBusTransportType
{
AmqpTcp = 0,
Expand Down Expand Up @@ -732,8 +731,6 @@ public ServiceBusAdministrationClient(string connectionString) { }
public ServiceBusAdministrationClient(string fullyQualifiedNamespace, Azure.Core.TokenCredential credential) { }
public ServiceBusAdministrationClient(string fullyQualifiedNamespace, Azure.Core.TokenCredential credential, Azure.Messaging.ServiceBus.Administration.ServiceBusAdministrationClientOptions options) { }
public ServiceBusAdministrationClient(string connectionString, Azure.Messaging.ServiceBus.Administration.ServiceBusAdministrationClientOptions options) { }
public ServiceBusAdministrationClient(string fullyQualifiedNamespace, Azure.Messaging.ServiceBus.ServiceBusSharedAccessKeyCredential credential) { }
public ServiceBusAdministrationClient(string fullyQualifiedNamespace, Azure.Messaging.ServiceBus.ServiceBusSharedAccessKeyCredential credential, Azure.Messaging.ServiceBus.Administration.ServiceBusAdministrationClientOptions options) { }
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.ServiceBus.Administration.QueueProperties>> CreateQueueAsync(Azure.Messaging.ServiceBus.Administration.CreateQueueOptions options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.ServiceBus.Administration.QueueProperties>> CreateQueueAsync(string name, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Messaging.ServiceBus.Administration.RuleProperties>> CreateRuleAsync(string topicName, string subscriptionName, Azure.Messaging.ServiceBus.Administration.CreateRuleOptions options, System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
Expand Down
6 changes: 3 additions & 3 deletions ...ervicebus/Azure.Messaging.ServiceBus/src/Administration/ServiceBusAdministrationClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public ServiceBusAdministrationClient(
{
Argument.AssertNotNullOrEmpty(connectionString, nameof(connectionString));
options ??= new ServiceBusAdministrationClientOptions();
ConnectionStringProperties connectionStringProperties = ConnectionStringParser.Parse(connectionString);
ServiceBusConnectionStringProperties connectionStringProperties = ServiceBusConnectionStringProperties.Parse(connectionString);

if (string.IsNullOrEmpty(connectionStringProperties.Endpoint?.Host)
|| string.IsNullOrEmpty(connectionStringProperties.SharedAccessKeyName)
Expand Down Expand Up @@ -115,7 +115,7 @@ public ServiceBusAdministrationClient(
///
/// <param name="fullyQualifiedNamespace">The fully qualified Service Bus namespace to connect to. This is likely to be similar to <c>{yournamespace}.servicebus.windows.net</c>.</param>
/// <param name="credential">The <see cref="ServiceBusSharedAccessKeyCredential"/> to use for authorization. Access controls may be specified by the Service Bus namespace or the requested Service Bus entity, depending on Azure configuration.</param>
public ServiceBusAdministrationClient(
internal ServiceBusAdministrationClient(
string fullyQualifiedNamespace,
ServiceBusSharedAccessKeyCredential credential)
: this(fullyQualifiedNamespace, credential, new ServiceBusAdministrationClientOptions())
Expand All @@ -129,7 +129,7 @@ public ServiceBusAdministrationClient(
/// <param name="fullyQualifiedNamespace">The fully qualified Service Bus namespace to connect to. This is likely to be similar to <c>{yournamespace}.servicebus.windows.net</c>.</param>
/// <param name="credential">The <see cref="ServiceBusSharedAccessKeyCredential"/> to use for authorization. Access controls may be specified by the Service Bus namespace or the requested Service Bus entity, depending on Azure configuration.</param>
/// <param name="options">A set of options to apply when configuring the connection.</param>
public ServiceBusAdministrationClient(
internal ServiceBusAdministrationClient(
string fullyQualifiedNamespace,
ServiceBusSharedAccessKeyCredential credential,
ServiceBusAdministrationClientOptions options)
Expand Down
2 changes: 1 addition & 1 deletion ...cebus/Azure.Messaging.ServiceBus/src/Authorization/ServiceBusSharedAccessKeyCredential.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ namespace Azure.Messaging.ServiceBus
/// Service Bus entity.
/// </summary>
///
public sealed class ServiceBusSharedAccessKeyCredential
internal sealed class ServiceBusSharedAccessKeyCredential
{
/// <summary>
/// The name of the shared access key to be used for authorization, as
Expand Down
4 changes: 2 additions & 2 deletions sdk/servicebus/Azure.Messaging.ServiceBus/src/Client/ServiceBusClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ public ServiceBusClient(string connectionString, ServiceBusClientOptions options
/// <param name="fullyQualifiedNamespace">The fully qualified Service Bus namespace to connect to.
/// This is likely to be similar to <c>{yournamespace}.servicebus.windows.net</c>.</param>
/// <param name="credential">The <see cref="ServiceBusSharedAccessKeyCredential"/> to use for authorization. Access controls may be specified by the Service Bus namespace.</param>
public ServiceBusClient(string fullyQualifiedNamespace, ServiceBusSharedAccessKeyCredential credential) :
internal ServiceBusClient(string fullyQualifiedNamespace, ServiceBusSharedAccessKeyCredential credential) :
this(fullyQualifiedNamespace, credential, new ServiceBusClientOptions())
{
}
Expand All @@ -159,7 +159,7 @@ public ServiceBusClient(string fullyQualifiedNamespace, ServiceBusSharedAccessKe
/// This is likely to be similar to <c>{yournamespace}.servicebus.windows.net</c>.</param>
/// <param name="credential">The <see cref="ServiceBusSharedAccessKeyCredential"/> to use for authorization. Access controls may be specified by the Service Bus namespace.</param>
/// <param name="options">The set of <see cref="ServiceBusClientOptions"/> to use for configuring this <see cref="ServiceBusClient"/>.</param>
public ServiceBusClient(
internal ServiceBusClient(
string fullyQualifiedNamespace,
ServiceBusSharedAccessKeyCredential credential,
ServiceBusClientOptions options)
Expand Down
165 changes: 0 additions & 165 deletions sdk/servicebus/Azure.Messaging.ServiceBus/src/Core/ConnectionStringParser.cs
View file

This file was deleted.

Loading

0 comments on commit 4c2f837

Please sign in to comment.