Skip to content

Commit d0bc85a

Browse files
committed
BasicAuthorization should be BasicAuthentication!
1 parent 1ff2e68 commit d0bc85a

File tree

9 files changed

+29
-11
lines changed

9 files changed

+29
-11
lines changed

src/Elasticsearch.Net/Connection/Configuration/ConnectionConfiguration.cs

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -336,9 +336,18 @@ public T SetConnectionStatusHandler(Action<IElasticsearchResponse> handler)
336336
}
337337

338338
/// <summary>
339-
/// Basic access authorization credentials to specify with all requests.
339+
/// Basic access authentication credentials to specify with all requests.
340340
/// </summary>
341+
[Obsolete("Scheduled to be removed in 2.0. Use SetBasicAuthentication() instead.")]
341342
public T SetBasicAuthorization(string userName, string password)
343+
{
344+
return this.SetBasicAuthentication(userName, password);
345+
}
346+
347+
/// <summary>
348+
/// Basic access authentication credentials to specify with all requests.
349+
/// </summary>
350+
public T SetBasicAuthentication(string userName, string password)
342351
{
343352
if (this._basicAuthCredentials == null)
344353
this._basicAuthCredentials = new BasicAuthorizationCredentials();

src/Elasticsearch.Net/Connection/Configuration/IConnectionConfigurationValues.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ public interface IConnectionConfigurationValues
7171
/// <summary>
7272
/// Basic access authorization credentials to specify with all requests.
7373
/// </summary>
74+
/// TODO: Rename to BasicAuthenticationCredentials in 2.0
7475
BasicAuthorizationCredentials BasicAuthorizationCredentials { get; }
7576
}
7677
}

src/Elasticsearch.Net/Connection/Configuration/IRequestConfiguration.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ public interface IRequestConfiguration
5353
/// Basic access authorization credentials to specify with this request.
5454
/// Overrides any credentials that are set at the global IConnectionSettings level.
5555
/// </summary>
56+
/// TODO: rename to BasicAuthenticationCredentials in 2.0
5657
BasicAuthorizationCredentials BasicAuthorizationCredentials { get; set; }
5758

5859
/// <summary>

src/Elasticsearch.Net/Connection/Configuration/RequestConfigurationDescriptor.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,13 @@ public RequestConfigurationDescriptor MaxRetries(int retry)
8181
return this;
8282
}
8383

84+
[Obsolete("Scheduled to be removed in 2.0. Use BasicAuthentication() instead.")]
8485
public RequestConfigurationDescriptor BasicAuthorization(string userName, string password)
86+
{
87+
return this.BasicAuthentication(userName, password);
88+
}
89+
90+
public RequestConfigurationDescriptor BasicAuthentication(string userName, string password)
8591
{
8692
if (Self.BasicAuthorizationCredentials == null)
8793
Self.BasicAuthorizationCredentials = new BasicAuthorizationCredentials();

src/Elasticsearch.Net/Connection/HttpConnection.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ private static void ThreadTimeoutCallback(object state, bool timedOut)
141141
protected virtual HttpWebRequest CreateHttpWebRequest(Uri uri, string method, byte[] data, IRequestConfiguration requestSpecificConfig)
142142
{
143143
var request = this.CreateWebRequest(uri, method, data, requestSpecificConfig);
144-
this.SetBasicAuthorizationIfNeeded(uri, request, requestSpecificConfig);
144+
this.SetBasicAuthenticationIfNeeded(uri, request, requestSpecificConfig);
145145
this.SetProxyIfNeeded(request);
146146
return request;
147147
}
@@ -164,7 +164,7 @@ private void SetProxyIfNeeded(HttpWebRequest myReq)
164164
}
165165
}
166166

167-
private void SetBasicAuthorizationIfNeeded(Uri uri, HttpWebRequest request, IRequestConfiguration requestSpecificConfig)
167+
private void SetBasicAuthenticationIfNeeded(Uri uri, HttpWebRequest request, IRequestConfiguration requestSpecificConfig)
168168
{
169169
// Basic auth credentials take the following precedence (highest -> lowest):
170170
// 1 - Specified on the request (highest precedence)

src/Elasticsearch.Net/Connection/Security/BasicAuthorizationCredentials.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55

66
namespace Elasticsearch.Net.Connection.Security
77
{
8+
// TODO: Rename to BasicAuthenticationCredentials in 2.0
89
public class BasicAuthorizationCredentials
910
{
1011
public string UserName { get; set; }

src/Tests/Nest.Tests.Integration/Connection/Security/BasicAuthorizationTests.cs renamed to src/Tests/Nest.Tests.Integration/Connection/Security/BasicAuthenticationTests.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ namespace Tests.Integration.Security.BasicAuthTests
1111
{
1212
[TestFixture]
1313
[Ignore]
14-
public class BasicAuthorizationTests
14+
public class BasicAuthenticationTests
1515
{
1616
[Test]
1717
public void No_Credentials_Result_In_401()
@@ -27,7 +27,7 @@ public void No_Credentials_Result_In_401()
2727
public void Invalid_Credentials_Result_In_401()
2828
{
2929
var settings = new ConnectionSettings(new Uri("http://localhost:9200"))
30-
.SetBasicAuthorization("nestuser", "incorrectpassword");
30+
.SetBasicAuthentication("nestuser", "incorrectpassword");
3131
var client = new ElasticClient(settings);
3232
var response = client.RootNodeInfo();
3333
response.IsValid.Should().BeFalse();
@@ -38,7 +38,7 @@ public void Invalid_Credentials_Result_In_401()
3838
public void Valid_Credentials_Result_In_200()
3939
{
4040
var settings = new ConnectionSettings(new Uri("http://localhost:9200"))
41-
.SetBasicAuthorization("nestuser", "elastic");
41+
.SetBasicAuthentication("nestuser", "elastic");
4242
var client = new ElasticClient(settings);
4343
var response = client.RootNodeInfo();
4444
response.IsValid.Should().BeTrue();
@@ -66,7 +66,7 @@ public void Escaped_Credentials_On_URI_Result_In_200()
6666
public void ConnectionSettings_Overrides_URI()
6767
{
6868
var settings = new ConnectionSettings(new Uri("http://invalid:user@localhost:9200"))
69-
.SetBasicAuthorization("nestuser", "elastic");
69+
.SetBasicAuthentication("nestuser", "elastic");
7070
var client = new ElasticClient(settings);
7171
var response = client.RootNodeInfo();
7272
response.IsValid.Should().BeTrue();
@@ -76,11 +76,11 @@ public void ConnectionSettings_Overrides_URI()
7676
public void RequestConfiguration_Overrides_ConnectionSettings()
7777
{
7878
var settings = new ConnectionSettings(new Uri("http://localhost:9200"))
79-
.SetBasicAuthorization("invalid", "user");
79+
.SetBasicAuthentication("invalid", "user");
8080
var client = new ElasticClient(settings);
8181
var response = client.RootNodeInfo(c => c
8282
.RequestConfiguration(rc => rc
83-
.BasicAuthorization("nestuser", "elastic")
83+
.BasicAuthentication("nestuser", "elastic")
8484
)
8585
);
8686
response.IsValid.Should().BeTrue();

src/Tests/Nest.Tests.Integration/ElasticsearchConfiguration.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ public static ConnectionSettings Settings(int? port = null, Uri hostOverride = n
4646
.DisableAutomaticProxyDetection(false)
4747
.UsePrettyResponses()
4848
.ExposeRawResponse()
49-
.SetBasicAuthorization("nestuser", "elastic");
49+
.SetBasicAuthentication("nestuser", "elastic");
5050
}
5151

5252
public static readonly Lazy<ElasticClient> Client = new Lazy<ElasticClient>(()=> new ElasticClient(Settings()));

src/Tests/Nest.Tests.Integration/Nest.Tests.Integration.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@
105105
<Compile Include="Cluster\StatsTest.cs" />
106106
<Compile Include="Connection\Failover\SniffTests.cs" />
107107
<Compile Include="Connection\HttpClient\HttpClientTests.cs" />
108-
<Compile Include="Connection\Security\BasicAuthorizationTests.cs" />
108+
<Compile Include="Connection\Security\BasicAuthenticationTests.cs" />
109109
<Compile Include="Connection\Security\UnauthorizedRequestTests.cs" />
110110
<Compile Include="Connection\Thrift\ThiftBugReportTests.cs" />
111111
<Compile Include="Core\Analyze\AnalyzeTests.cs" />

0 commit comments

Comments
 (0)