Skip to content

Commit eddeaa5

Browse files
Clarify behavior of CredentialsProvider. (#537)
## What changes are proposed in this pull request? This PR clarifies behavior and expectation for method `CredentialsProvider.configure()` to return a new `HeaderFactory` instance on each invocation. ## How is this tested? N/A
1 parent ffbfe37 commit eddeaa5

File tree

2 files changed

+19
-0
lines changed

2 files changed

+19
-0
lines changed

NEXT_CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
### Documentation
1212

13+
* Clarify behavior and expectation for method `CredentialsProvider.configure()` to return a new `HeaderFactory` instance on each invocation.
14+
1315
### Internal Changes
1416

1517
### API Changes
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,24 @@
11
package com.databricks.sdk.core;
22

3+
/**
4+
* CredentialsProvider is an interface that provides a HeaderFactory to authenticate requests to the
5+
* Databricks API.
6+
*/
37
public interface CredentialsProvider {
8+
/**
9+
* Returns the authentication type identifier for this credentials provider.
10+
*
11+
* @return the authentication type as a string
12+
*/
413
String authType();
514

15+
/**
16+
* Creates and returns a new HeaderFactory to authenticate requests to the Databricks API.
17+
*
18+
* <p>Note: A new HeaderFactory instance is returned on each invocation.
19+
*
20+
* @param config the Databricks configuration to use for authentication
21+
* @return a new HeaderFactory configured for authenticating API requests
22+
*/
623
HeaderFactory configure(DatabricksConfig config);
724
}

0 commit comments

Comments
 (0)