feat: Implemented new authentication framework design

Author: padamstx

build/checkstyle-suppressions.xml

@@ -5,8 +5,9 @@
         "http://checkstyle.sourceforge.net/dtds/suppressions_1_1.dtd">
 
 <suppressions>
-    <suppress checks="MemberName" files="ICP4DTokenResponse.java"/>
-    <suppress checks="MethodName" files="ICP4DTokenResponse.java"/>
+    <suppress checks="MemberName" files="Cp4dTokenResponse.java"/>
+    <suppress checks="MethodName" files="Cp4dTokenResponse.java"/>
     <suppress checks="WhitespaceAround" files="JsonWebToken.java"/>
     <suppress checks="LineLength" files="JsonWebTokenTest.java"/>
+    <suppress checks="HideUtilityClassConstructor" files="AuthenticatorBase.java"/>
 </suppressions>

ibm-credentials.env

@@ -1,2 +1,3 @@
 NATURAL_LANGUAGE_CLASSIFIER_IAM_APIKEY=123456789
-NATURAL_LANGUAGE_CLASSIFIER_URL=https://gateway.watsonplatform.net/natural-language-classifier/api
+NATURAL_LANGUAGE_CLASSIFIER_URL=https://gateway.watsonplatform.net/natural-language-classifier/api
+NATURAL_LANGUAGE_CLASSIFIER_DISABLE_SSL=true

pom.xml

@@ -50,6 +50,8 @@
         <commons-io-version>2.6</commons-io-version>
         <commons-lang3-version>3.8.1</commons-lang3-version>
         <rx-version>2.2.7</rx-version>
+        <mockito-version>2.0.5-beta</mockito-version>
+        <powermock-version>1.6.2</powermock-version>
     </properties>
 
     <!-- we use the travis providers for deployment so don't need to specify repositories here -->
@@ -140,6 +142,23 @@
             <artifactId>rxjava</artifactId>
             <version>${rx-version}</version>
         </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-core</artifactId>
+            <version>${mockito-version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.powermock</groupId>
+            <artifactId>powermock-api-mockito</artifactId>
+            <version>${powermock-version}</version>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.powermock</groupId>
+            <artifactId>powermock-module-junit4</artifactId>
+            <version>${powermock-version}</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>

src/main/java/com/ibm/cloud/sdk/core/http/RequestBuilder.java

@@ -205,7 +205,7 @@ private void addParam(List<NameValue> params, String name, Object value) {
   }
 
   /**
-   * Builds the.
+   * Builds the request.
    *
    * @return the request
    */

src/main/java/com/ibm/cloud/sdk/core/security/noauth/NoauthConfig.java renamed to src/main/java/com/ibm/cloud/sdk/core/security/AbstractToken.java

@@ -10,26 +10,12 @@
  * 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.noauth;
-
-import com.ibm.cloud.sdk.core.security.Authenticator;
-import com.ibm.cloud.sdk.core.security.AuthenticatorConfig;
+package com.ibm.cloud.sdk.core.security;
 
 /**
- * This AuthenticatorConfig subclass is used in situations where we want to bypass authentication.
+ * This class defines a common base class for tokens returned by a token server.
  */
-public class NoauthConfig implements AuthenticatorConfig {
-
-  public NoauthConfig() {
-  }
-
-  @Override
-  public String authenticationType() {
-    return Authenticator.AUTHTYPE_NOAUTH;
-  }
-
-  @Override
-  public void validate() {
-  }
-
+public abstract class AbstractToken {
+  public abstract boolean isTokenValid();
+  public abstract String getAccessToken();
 }

src/main/java/com/ibm/cloud/sdk/core/security/Authenticator.java

@@ -15,7 +15,7 @@
 import okhttp3.Request.Builder;
 
 /**
- * This interface defines the common methods associated with an Authenticator implementation.
+ * This interface defines the common methods and constants associated with an Authenticator implementation.
  */
 public interface Authenticator {
 
@@ -25,7 +25,26 @@ public interface Authenticator {
   String AUTHTYPE_BASIC = "basic";
   String AUTHTYPE_NOAUTH = "noauth";
   String AUTHTYPE_IAM = "iam";
-  String AUTHTYPE_ICP4D = "icp4d";
+  String AUTHTYPE_CP4D = "cp4d";
+  String AUTHTYPE_BEARER_TOKEN = "bearerToken";
+
+  /**
+   * Constants which define the names of external config propreties (credential file, environment variable, etc.).
+   */
+  String PROPNAME_AUTH_TYPE = "AUTH_TYPE";
+  String PROPNAME_USERNAME = "USERNAME";
+  String PROPNAME_PASSWORD = "PASSWORD";
+  String PROPNAME_BEARER_TOKEN = "BEARER_TOKEN";
+  String PROPNAME_URL = "AUTH_URL";
+  String PROPNAME_DISABLE_SSL = "AUTH_DISABLE_SSL";
+  String PROPNAME_APIKEY = "APIKEY";
+  String PROPNAME_CLIENT_ID = "CLIENT_ID";
+  String PROPNAME_CLIENT_SECRET = "CLIENT_SECRET";
+
+  /**
+   * Validates the current set of configuration information in the Authenticator.
+   */
+  void validate();
 
   /**
    * Returns the authentication type associated with the Authenticator instance.

src/main/java/com/ibm/cloud/sdk/core/security/AuthenticatorBase.java

@@ -0,0 +1,56 @@
+/**
+ * Copyright 2019 IBM Corp. All Rights Reserved.
+ *
+ * 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.google.common.io.BaseEncoding;
+
+/**
+ * This is a common base class used with the various Authenticator implementations.
+ */
+public class AuthenticatorBase {
+
+  /**
+   * Common error messages.
+   */
+  public static final String ERRORMSG_PROP_MISSING = "The %s property is required but was not specified.";
+  public static final String ERRORMSG_PROP_INVALID =
+      "The %s property is invalid. Please remove any surrounding {, }, or \" characters.";
+  public static final String ERRORMSG_REQ_FAILED = "Error while fetching access token from token service: ";
+
+  /**
+   * Returns a "Basic" Authorization header value for the specified username and password.
+   * @param username the username
+   * @param password the password
+   * @return the Authorization header value in the form "Basic <encoded username and password>"
+   */
+  public static String constructBasicAuthHeader(String username, String password) {
+    if (StringUtils.isNotEmpty(username) && StringUtils.isNotEmpty(password)) {
+      return "Basic " + BaseEncoding.base64().encode(((username + ":" + password).getBytes()));
+    }
+    return null;
+  }
+
+  /**
+   * Returns a "Bearer" Authorization header value for the specified bearer token.
+   * @param bearerToken the token value to be included in the header
+   * @return the Authorization header value in the form "Bearer <bearerToken>"
+   */
+  public static String constructBearerTokenAuthHeader(String bearerToken) {
+    if (StringUtils.isNotEmpty(bearerToken)) {
+      return "Bearer " + bearerToken;
+    }
+    return null;
+  }
+}