refactor: prepare for ContainerAuthenticator impl #139
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| /** | ||
| * (C) Copyright IBM Corp. 2015, 2021. | ||
|
There was a problem hiding this comment. This is the new base class. I'll leave the initial copyright year (2015) here since this code was copied from the other file. |
||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on | ||
| * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| package com.ibm.cloud.sdk.core.security; | ||
|
|
||
| import org.apache.commons.lang3.StringUtils; | ||
|
|
||
| import com.ibm.cloud.sdk.core.http.HttpHeaders; | ||
| import com.ibm.cloud.sdk.core.http.RequestBuilder; | ||
|
|
||
| /** | ||
| * This class contains code that is common to all authenticators that need to | ||
| * interact with the IAM tokens service to obtain an access token. | ||
| */ | ||
| public abstract class IamRequestBasedAuthenticator | ||
| extends TokenRequestBasedAuthenticator<IamToken, IamToken> | ||
| implements Authenticator { | ||
|
|
||
| private static final String DEFAULT_IAM_URL = "https://iam.cloud.ibm.com"; | ||
|
|
||
| // Properties common to IAM-based authenticators. | ||
| private String url; | ||
| private String scope; | ||
| private String clientId; | ||
| private String clientSecret; | ||
|
|
||
| // This is the value of the Authorization header we'll use when interacting with the token server. | ||
| protected String cachedAuthorizationHeader = null; | ||
|
|
||
|
|
||
| @Override | ||
| public void validate() { | ||
| if (StringUtils.isEmpty(getClientId()) && StringUtils.isEmpty(getClientSecret())) { | ||
| // both empty is ok. | ||
| } else { | ||
| if (StringUtils.isEmpty(getClientId())) { | ||
| throw new IllegalArgumentException(String.format(ERRORMSG_PROP_MISSING, "clientId")); | ||
| } | ||
| if (StringUtils.isEmpty(getClientSecret())) { | ||
| throw new IllegalArgumentException(String.format(ERRORMSG_PROP_MISSING, "clientSecret")); | ||
| } | ||
| } | ||
|
|
||
| // Assuming everything validates clean, let's cache the basic auth header if | ||
| // the clientId/clientSecret properties are configured. | ||
| this.cachedAuthorizationHeader = constructBasicAuthHeader(this.clientId, this.clientSecret); | ||
| } | ||
|
|
||
| /** | ||
| * @return the URL configured on this Authenticator. | ||
| */ | ||
| public String getURL() { | ||
| return this.url; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the URL on this Authenticator. | ||
| * @param url the URL representing the IAM token server endpoint | ||
| */ | ||
| public void setURL(String url) { | ||
| if (StringUtils.isEmpty(url)) { | ||
| url = DEFAULT_IAM_URL; | ||
| } | ||
| this.url = url; | ||
| } | ||
|
|
||
| /** | ||
| * @return the clientId configured on this Authenticator. | ||
| */ | ||
| public String getClientId() { | ||
| return this.clientId; | ||
| } | ||
|
|
||
| /** | ||
| * @return the clientSecret configured on this Authenticator. | ||
| */ | ||
| public String getClientSecret() { | ||
| return this.clientSecret; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the clientId and clientSecret on this Authenticator. | ||
| * @param clientId the clientId to use in interactions with the token server | ||
| * @param clientSecret the clientSecret to use in interactions with the token server | ||
| */ | ||
| public void setClientIdAndSecret(String clientId, String clientSecret) { | ||
| this.clientId = clientId; | ||
| this.clientSecret = clientSecret; | ||
| this.validate(); | ||
| } | ||
|
|
||
| /** | ||
| * @return the scope parameter | ||
| */ | ||
| public String getScope() { | ||
| return this.scope; | ||
| } | ||
|
|
||
| /** | ||
| * Sets the "scope" parameter to use when fetching the bearer token from the IAM token server. | ||
| * @param value a space seperated string that makes up the scope parameter. | ||
| */ | ||
| public void setScope(String value) { | ||
| this.scope = value; | ||
| } | ||
|
|
||
| /** | ||
| * If a basic auth Authorization header is cached in "this", then add it to | ||
| * the specified request builder. | ||
| * @param builder the request builder | ||
| */ | ||
| protected void addAuthorizationHeader(RequestBuilder builder) { | ||
| if (StringUtils.isNotEmpty(this.cachedAuthorizationHeader)) { | ||
| builder.header(HttpHeaders.AUTHORIZATION, this.cachedAuthorizationHeader); | ||
| } | ||
| } | ||
| } | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed these constants because they are used only in the requestToken() function and I actually think the code is more readable and understandable WITHOUT using these contants.