Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit f6ac4d3

Browse filesBrowse files
author
Marcos.Cela
committed
rename: credential provider -> authorization provider
This includes renames in comments, related methods, javadocs and fields/variables.
1 parent 6670446 commit f6ac4d3
Copy full SHA for f6ac4d3

File tree

Expand file treeCollapse file tree

19 files changed

+117
-123
lines changed
Filter options
Expand file treeCollapse file tree

19 files changed

+117
-123
lines changed

‎src/main/java/org/kohsuke/github/CredentialProvider.java renamed to ‎src/main/java/org/kohsuke/github/AuthorizationProvider.java

Copy file name to clipboardExpand all lines: src/main/java/org/kohsuke/github/AuthorizationProvider.java
+8-8Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@
66
* Provides a functional interface that returns a valid encodedAuthorization. This strategy allows for a provider that
77
* dynamically changes the credentials. Each request will request the credentials from the provider.
88
*/
9-
public interface CredentialProvider {
9+
public interface AuthorizationProvider {
1010
/**
11-
* An static instance for an ANONYMOUS credential provider
11+
* An static instance for an ANONYMOUS authorization provider
1212
*/
13-
CredentialProvider ANONYMOUS = new AnonymousCredentialProvider();
13+
AuthorizationProvider ANONYMOUS = new AnonymousAuthorizationProvider();
1414

1515
/**
16-
* Returns the credentials to be used with a given request. As an example, a credential provider for a bearer token
17-
* will return something like:
16+
* Returns the credentials to be used with a given request. As an example, a authorization provider for a bearer
17+
* token will return something like:
1818
*
1919
* <pre>
2020
* {@code
@@ -32,7 +32,7 @@ public interface CredentialProvider {
3232
String getEncodedAuthorization() throws IOException;
3333

3434
/**
35-
* Binds this credential provider to a github instance.
35+
* Binds this authorization provider to a github instance.
3636
*
3737
* Only needs to be implemented by dynamic credentials providers that use a github instance in order to refresh.
3838
*
@@ -43,9 +43,9 @@ default void bind(GitHub github) {
4343
}
4444

4545
/**
46-
* A {@link CredentialProvider} that ensures that no credentials are returned
46+
* A {@link AuthorizationProvider} that ensures that no credentials are returned
4747
*/
48-
class AnonymousCredentialProvider implements CredentialProvider {
48+
class AnonymousAuthorizationProvider implements AuthorizationProvider {
4949
@Override
5050
public String getEncodedAuthorization() throws IOException {
5151
return null;

‎src/main/java/org/kohsuke/github/GitHub.java

Copy file name to clipboardExpand all lines: src/main/java/org/kohsuke/github/GitHub.java
+10-10Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -101,23 +101,23 @@ public class GitHub {
101101
* abuseLimitHandler
102102
* @param rateLimitChecker
103103
* rateLimitChecker
104-
* @param credentialProvider
105-
* a credential provider
104+
* @param authorizationProvider
105+
* a authorization provider
106106
*/
107107
GitHub(String apiUrl,
108108
HttpConnector connector,
109109
RateLimitHandler rateLimitHandler,
110110
AbuseLimitHandler abuseLimitHandler,
111111
GitHubRateLimitChecker rateLimitChecker,
112-
CredentialProvider credentialProvider) throws IOException {
113-
credentialProvider.bind(this);
112+
AuthorizationProvider authorizationProvider) throws IOException {
113+
authorizationProvider.bind(this);
114114
this.client = new GitHubHttpUrlConnectionClient(apiUrl,
115115
connector,
116116
rateLimitHandler,
117117
abuseLimitHandler,
118118
rateLimitChecker,
119119
(myself) -> setMyself(myself),
120-
credentialProvider);
120+
authorizationProvider);
121121
users = new ConcurrentHashMap<>();
122122
orgs = new ConcurrentHashMap<>();
123123
}
@@ -130,20 +130,20 @@ private GitHub(GitHubClient client) {
130130

131131
static class CredentialRefreshGitHubWrapper extends GitHub {
132132

133-
private final CredentialProvider credentialProvider;
133+
private final AuthorizationProvider authorizationProvider;
134134

135-
CredentialRefreshGitHubWrapper(GitHub github, CredentialProvider credentialProvider) {
135+
CredentialRefreshGitHubWrapper(GitHub github, AuthorizationProvider authorizationProvider) {
136136
super(github.client);
137-
this.credentialProvider = credentialProvider;
138-
this.credentialProvider.bind(this);
137+
this.authorizationProvider = authorizationProvider;
138+
this.authorizationProvider.bind(this);
139139
}
140140

141141
@Nonnull
142142
@Override
143143
Requester createRequest() {
144144
try {
145145
// Override
146-
return super.createRequest().setHeader("Authorization", credentialProvider.getEncodedAuthorization())
146+
return super.createRequest().setHeader("Authorization", authorizationProvider.getEncodedAuthorization())
147147
.rateLimit(RateLimitTarget.NONE);
148148
} catch (IOException e) {
149149
throw new GHException("Failed to create requester to refresh credentials", e);

‎src/main/java/org/kohsuke/github/GitHubBuilder.java

Copy file name to clipboardExpand all lines: src/main/java/org/kohsuke/github/GitHubBuilder.java
+15-15Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public class GitHubBuilder implements Cloneable {
3030
private RateLimitHandler rateLimitHandler = RateLimitHandler.WAIT;
3131
private AbuseLimitHandler abuseLimitHandler = AbuseLimitHandler.WAIT;
3232
private GitHubRateLimitChecker rateLimitChecker = new GitHubRateLimitChecker();
33-
/* private */ CredentialProvider credentialProvider = CredentialProvider.ANONYMOUS;
33+
/* private */ AuthorizationProvider authorizationProvider = AuthorizationProvider.ANONYMOUS;
3434

3535
/**
3636
* Instantiates a new Git hub builder.
@@ -58,13 +58,13 @@ static GitHubBuilder fromCredentials() throws IOException {
5858

5959
builder = fromEnvironment();
6060

61-
if (builder.credentialProvider != null)
61+
if (builder.authorizationProvider != null)
6262
return builder;
6363

6464
try {
6565
builder = fromPropertyFile();
6666

67-
if (builder.credentialProvider != null)
67+
if (builder.authorizationProvider != null)
6868
return builder;
6969
} catch (FileNotFoundException e) {
7070
// fall through
@@ -255,7 +255,7 @@ public GitHubBuilder withEndpoint(String endpoint) {
255255
* @return the git hub builder
256256
*/
257257
public GitHubBuilder withPassword(String user, String password) {
258-
return withCredentialProvider(ImmutableCredentialProvider.fromLoginAndPassword(user, password));
258+
return withAuthorizationProvider(ImmutableAuthorizationProvider.fromLoginAndPassword(user, password));
259259
}
260260

261261
/**
@@ -266,7 +266,7 @@ public GitHubBuilder withPassword(String user, String password) {
266266
* @return the git hub builder
267267
*/
268268
public GitHubBuilder withOAuthToken(String oauthToken) {
269-
return withCredentialProvider(ImmutableCredentialProvider.fromOauthToken(oauthToken));
269+
return withAuthorizationProvider(ImmutableAuthorizationProvider.fromOauthToken(oauthToken));
270270
}
271271

272272
/**
@@ -279,21 +279,21 @@ public GitHubBuilder withOAuthToken(String oauthToken) {
279279
* @return the git hub builder
280280
*/
281281
public GitHubBuilder withOAuthToken(String oauthToken, String user) {
282-
return withCredentialProvider(ImmutableCredentialProvider.fromOauthToken(oauthToken, user));
282+
return withAuthorizationProvider(ImmutableAuthorizationProvider.fromOauthToken(oauthToken, user));
283283
}
284284

285285
/**
286-
* Configures a {@link CredentialProvider} for this builder
286+
* Configures a {@link AuthorizationProvider} for this builder
287287
*
288-
* There can be only one credential provider per client instance.
288+
* There can be only one authorization provider per client instance.
289289
*
290-
* @param credentialProvider
291-
* the credential provider
290+
* @param authorizationProvider
291+
* the authorization provider
292292
* @return the git hub builder
293293
*
294294
*/
295-
public GitHubBuilder withCredentialProvider(final CredentialProvider credentialProvider) {
296-
this.credentialProvider = credentialProvider;
295+
public GitHubBuilder withAuthorizationProvider(final AuthorizationProvider authorizationProvider) {
296+
this.authorizationProvider = authorizationProvider;
297297
return this;
298298
}
299299

@@ -306,7 +306,7 @@ public GitHubBuilder withCredentialProvider(final CredentialProvider credentialP
306306
* @see GHAppInstallation#createToken(java.util.Map) GHAppInstallation#createToken(java.util.Map)
307307
*/
308308
public GitHubBuilder withAppInstallationToken(String appInstallationToken) {
309-
return withCredentialProvider(ImmutableCredentialProvider.fromAppInstallationToken(appInstallationToken));
309+
return withAuthorizationProvider(ImmutableAuthorizationProvider.fromAppInstallationToken(appInstallationToken));
310310
}
311311

312312
/**
@@ -317,7 +317,7 @@ public GitHubBuilder withAppInstallationToken(String appInstallationToken) {
317317
* @return the git hub builder
318318
*/
319319
public GitHubBuilder withJwtToken(String jwtToken) {
320-
return withCredentialProvider(ImmutableCredentialProvider.fromJwtToken(jwtToken));
320+
return withAuthorizationProvider(ImmutableAuthorizationProvider.fromJwtToken(jwtToken));
321321
}
322322

323323
/**
@@ -443,7 +443,7 @@ public GitHub build() throws IOException {
443443
rateLimitHandler,
444444
abuseLimitHandler,
445445
rateLimitChecker,
446-
credentialProvider);
446+
authorizationProvider);
447447
}
448448

449449
@Override

‎src/main/java/org/kohsuke/github/GitHubClient.java

Copy file name to clipboardExpand all lines: src/main/java/org/kohsuke/github/GitHubClient.java
+10-9Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
import com.fasterxml.jackson.databind.*;
44
import com.fasterxml.jackson.databind.introspect.VisibilityChecker;
55
import org.apache.commons.io.IOUtils;
6+
import org.kohsuke.github.ImmutableAuthorizationProvider.UserAuthorizationProvider;
67

78
import java.io.FileNotFoundException;
89
import java.io.IOException;
@@ -46,7 +47,7 @@ abstract class GitHubClient {
4647
protected final RateLimitHandler rateLimitHandler;
4748
protected final AbuseLimitHandler abuseLimitHandler;
4849
private final GitHubRateLimitChecker rateLimitChecker;
49-
private final CredentialProvider credentialProvider;
50+
private final AuthorizationProvider authorizationProvider;
5051

5152
private HttpConnector connector;
5253

@@ -76,7 +77,7 @@ abstract class GitHubClient {
7677
AbuseLimitHandler abuseLimitHandler,
7778
GitHubRateLimitChecker rateLimitChecker,
7879
Consumer<GHMyself> myselfConsumer,
79-
CredentialProvider credentialProvider) throws IOException {
80+
AuthorizationProvider authorizationProvider) throws IOException {
8081

8182
if (apiUrl.endsWith("/")) {
8283
apiUrl = apiUrl.substring(0, apiUrl.length() - 1); // normalize
@@ -89,7 +90,7 @@ abstract class GitHubClient {
8990
this.connector = connector;
9091

9192
// Prefer credential configuration via provider
92-
this.credentialProvider = credentialProvider;
93+
this.authorizationProvider = authorizationProvider;
9394

9495
this.rateLimitHandler = rateLimitHandler;
9596
this.abuseLimitHandler = abuseLimitHandler;
@@ -100,12 +101,12 @@ abstract class GitHubClient {
100101

101102
private String getCurrentUser(Consumer<GHMyself> myselfConsumer) throws IOException {
102103
String login = null;
103-
if (this.credentialProvider instanceof ImmutableCredentialProvider.UserCredentialProvider
104-
&& this.credentialProvider.getEncodedAuthorization() != null) {
104+
if (this.authorizationProvider instanceof UserAuthorizationProvider
105+
&& this.authorizationProvider.getEncodedAuthorization() != null) {
105106

106-
ImmutableCredentialProvider.UserCredentialProvider userCredentialProvider = (ImmutableCredentialProvider.UserCredentialProvider) this.credentialProvider;
107+
UserAuthorizationProvider userAuthorizationProvider = (UserAuthorizationProvider) this.authorizationProvider;
107108

108-
login = userCredentialProvider.getLogin();
109+
login = userAuthorizationProvider.getLogin();
109110

110111
if (login == null) {
111112
try {
@@ -185,7 +186,7 @@ public void setConnector(HttpConnector connector) {
185186
*/
186187
public boolean isAnonymous() {
187188
try {
188-
return login == null && this.credentialProvider.getEncodedAuthorization() == null;
189+
return login == null && this.authorizationProvider.getEncodedAuthorization() == null;
189190
} catch (IOException e) {
190191
// An exception here means that the provider failed to provide authorization parameters,
191192
// basically meaning the same as "no auth"
@@ -214,7 +215,7 @@ public GHRateLimit getRateLimit() throws IOException {
214215

215216
@CheckForNull
216217
protected String getEncodedAuthorization() throws IOException {
217-
return credentialProvider.getEncodedAuthorization();
218+
return authorizationProvider.getEncodedAuthorization();
218219
}
219220

220221
@Nonnull

‎src/main/java/org/kohsuke/github/GitHubHttpUrlConnectionClient.java

Copy file name to clipboardExpand all lines: src/main/java/org/kohsuke/github/GitHubHttpUrlConnectionClient.java
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,14 @@ class GitHubHttpUrlConnectionClient extends GitHubClient {
3838
AbuseLimitHandler abuseLimitHandler,
3939
GitHubRateLimitChecker rateLimitChecker,
4040
Consumer<GHMyself> myselfConsumer,
41-
CredentialProvider credentialProvider) throws IOException {
41+
AuthorizationProvider authorizationProvider) throws IOException {
4242
super(apiUrl,
4343
connector,
4444
rateLimitHandler,
4545
abuseLimitHandler,
4646
rateLimitChecker,
4747
myselfConsumer,
48-
credentialProvider);
48+
authorizationProvider);
4949
}
5050

5151
@Nonnull

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.