Merge pull request #173 from oracle/remove-httpclient-unused-principal

remove unused principal field from HttpClient

Author: rjeberhard

operator/src/main/java/oracle/kubernetes/operator/http/HttpClient.java

@@ -35,17 +35,15 @@ public class HttpClient {
   private static final LoggingFacade LOGGER = LoggingFactory.getLogger("Operator", "Operator");
 
   private Client httpClient;
-  private String principal;
   private String encodedCredentials;
 
   private static final String HTTP_PROTOCOL = "http://";
 
   // for debugging
   private static final String SERVICE_URL = System.getProperty("oracle.kubernetes.operator.http.HttpClient.SERVICE_URL");
 
-  private HttpClient(Client httpClient, String principal, String encodedCredentials) {
+  private HttpClient(Client httpClient, String encodedCredentials) {
     this.httpClient = httpClient;
-    this.principal = principal;
     this.encodedCredentials = encodedCredentials;
   }
 
@@ -144,14 +142,13 @@ public Result executePostUrlOnServiceClusterIP(String requestUrl, String service
 
   /**
    * Asynchronous {@link Step} for creating an authenticated HTTP client targeted at a server instance
-   * @param principal Principal
    * @param namespace Namespace
    * @param adminSecretName Admin secret name
    * @param next Next processing step
    * @return step to create client
    */
-  public static Step createAuthenticatedClientForServer(String principal, String namespace, String adminSecretName, Step next) {
-    return new AuthenticatedClientForServerStep(namespace, adminSecretName, new WithSecretDataStep(principal, next));
+  public static Step createAuthenticatedClientForServer(String namespace, String adminSecretName, Step next) {
+    return new AuthenticatedClientForServerStep(namespace, adminSecretName, new WithSecretDataStep(next));
   }
 
   private static class AuthenticatedClientForServerStep extends Step {
@@ -172,11 +169,9 @@ public NextAction apply(Packet packet) {
   }
 
   private static class WithSecretDataStep extends Step {
-    private final String principal;
 
-    public WithSecretDataStep(String principal, Step next) {
+    public WithSecretDataStep(Step next) {
       super(next);
-      this.principal = principal;
     }
 
     @Override
@@ -189,7 +184,7 @@ public NextAction apply(Packet packet) {
         username = secretData.get(SecretHelper.ADMIN_SERVER_CREDENTIALS_USERNAME);
         password = secretData.get(SecretHelper.ADMIN_SERVER_CREDENTIALS_PASSWORD);
       }
-      packet.put(KEY, createAuthenticatedClient(principal, username, password));
+      packet.put(KEY, createAuthenticatedClient(username, password));
 
       Arrays.fill(username, (byte) 0); 
       Arrays.fill(password, (byte) 0); 
@@ -199,12 +194,11 @@ public NextAction apply(Packet packet) {
 
   /**
    * Create authenticated client specifically targeted at an admin server
-   * @param principal Principal
    * @param namespace Namespace
    * @param adminSecretName Admin secret name
    * @return authenticated client
    */
-  public static HttpClient createAuthenticatedClientForServer(String principal, String namespace, String adminSecretName) {
+  public static HttpClient createAuthenticatedClientForServer(String namespace, String adminSecretName) {
     SecretHelper secretHelper = new SecretHelper(namespace);
     Map<String, byte[]> secretData =
         secretHelper.getSecretData(SecretHelper.SecretType.AdminCredentials, adminSecretName);
@@ -215,18 +209,16 @@ public static HttpClient createAuthenticatedClientForServer(String principal, St
       username = secretData.get(SecretHelper.ADMIN_SERVER_CREDENTIALS_USERNAME);
       password = secretData.get(SecretHelper.ADMIN_SERVER_CREDENTIALS_PASSWORD);
     }
-    return createAuthenticatedClient(principal, username, password);
+    return createAuthenticatedClient(username, password);
   }
 
   /**
    * Create authenticated HTTP client
-   * @param principal Principal
    * @param username Username
    * @param password Password
    * @return authenticated client
    */
-  public static HttpClient createAuthenticatedClient(String principal,
-                                                     final byte[] username,
+  public static HttpClient createAuthenticatedClient(final byte[] username,
                                                      final byte[] password) {
     // build client with authentication information.
     Client client = ClientBuilder.newClient();
@@ -238,18 +230,17 @@ public static HttpClient createAuthenticatedClient(String principal,
       System.arraycopy(password, 0, usernameAndPassword, username.length + 1, password.length);
       encodedCredentials = java.util.Base64.getEncoder().encodeToString(usernameAndPassword);
     }
-    return new HttpClient(client, principal, encodedCredentials);
+    return new HttpClient(client, encodedCredentials);
   }
 
   /**
    * Returns the URL to access the service; using the service clusterIP and port.
    *
-   * @param principal The principal that will be used to call the Kubernetes API.
    * @param name The name of the Service that you want the URL for.
    * @param namespace The Namespace in which the Service you want the URL for is defined.
-   * @return The URL of the Service, or null if it is not found or principal does not have sufficient permissions.
+   * @return The URL of the Service, or null if it is not found
    */
-  public static String getServiceURL(String principal, String name, String namespace) {
+  public static String getServiceURL(String name, String namespace) {
     try {
       CallBuilderFactory factory = ContainerResolver.getInstance().getContainer().getSPI(CallBuilderFactory.class);
       return getServiceURL(factory.create().readService(name, namespace));

operator/src/main/java/oracle/kubernetes/operator/rest/RestBackendImpl.java

@@ -337,14 +337,14 @@ private ClusterStartup getClusterStartup(Domain domain, String cluster) {
 
   private int getWLSConfiguredClusterSize(String adminServerServiceName, String cluster, String namespace, String adminSecretName) {
     WlsRetriever wlsConfigRetriever = WlsRetriever.create(namespace, adminServerServiceName, adminSecretName);
-    WlsDomainConfig wlsDomainConfig = wlsConfigRetriever.readConfig(principal);
+    WlsDomainConfig wlsDomainConfig = wlsConfigRetriever.readConfig();
     WlsClusterConfig wlsClusterConfig = wlsDomainConfig.getClusterConfig(cluster);
     return wlsClusterConfig.getClusterSize();
   }
 
   private Map<String, WlsClusterConfig> getWLSConfiguredClusters(String namespace, String adminServerServiceName,  String adminSecretName) {
     WlsRetriever wlsConfigRetriever = WlsRetriever.create(namespace, adminServerServiceName, adminSecretName);
-    WlsDomainConfig wlsDomainConfig = wlsConfigRetriever.readConfig(principal);
+    WlsDomainConfig wlsDomainConfig = wlsConfigRetriever.readConfig();
     return wlsDomainConfig.getClusterConfigs();
   }
 

operator/src/main/java/oracle/kubernetes/operator/wlsconfig/WlsRetriever.java

@@ -125,8 +125,7 @@ public ReadStep(RequestType requestType, Step next) {
     public NextAction apply(Packet packet) {
       try {
         DomainPresenceInfo info = packet.getSPI(DomainPresenceInfo.class);
-        String principal = (String) packet.get(ProcessingConstants.PRINCIPAL);
-        
+
         packet.putIfAbsent(START_TIME, Long.valueOf(System.currentTimeMillis()));
 
         Domain dom = info.getDomain();
@@ -145,7 +144,7 @@ public NextAction apply(Packet packet) {
         String adminSecretName = spec.getAdminSecret() == null ? null : spec.getAdminSecret().getName();
 
         Step getClient = HttpClient.createAuthenticatedClientForServer(
-            principal, namespace, adminSecretName, 
+            namespace, adminSecretName,
             new WithHttpClientStep(requestType, namespace, sko.getService().get(), next));
         packet.remove(RETRY_COUNT);
         return doNext(getClient, packet);
@@ -287,20 +286,18 @@ public static String getRetrieveHealthSearchPayload() {
    * would repeatedly try to connect to the admin server to retrieve the configuration until the configured timeout
    * occurs.
    *
-   * @param principal The principal that should be used to retrieve the configuration.
-   *
    * @return A WlsClusterConfig object containing selected server configurations of all WLS servers configured in the
    * domain that belongs to a cluster. This method returns an empty configuration object even if it fails to retrieve
    * WLS configuration from the admin server.
    */
-  public WlsDomainConfig readConfig(String principal) {
+  public WlsDomainConfig readConfig() {
 
     LOGGER.entering();
 
     long timeout = READ_CONFIG_TIMEOUT_MILLIS;
     ScheduledExecutorService executorService = ContainerResolver.getInstance().getContainer().getSPI(ScheduledExecutorService.class);
     long startTime = System.currentTimeMillis();
-    Future<WlsDomainConfig> future = executorService.submit(() -> getWlsDomainConfig(principal, timeout));
+    Future<WlsDomainConfig> future = executorService.submit(() -> getWlsDomainConfig(timeout));
     executorService.shutdown();
     WlsDomainConfig wlsConfig = null;
     try {
@@ -323,14 +320,13 @@ public WlsDomainConfig readConfig(String principal) {
    * Method called by the Callable that is submitted from the readConfig method for reading the WLS server
    * configurations
    *
-   * @param principal The Service Account or User to use when accessing WebLogic.
    * @param timeout Maximum amount of time in millis to try to read configuration from the admin server before giving up
    * @return A WlsClusterConfig object containing selected server configurations of all WLS servers configured in the
    * cluster. Method returns empty configuration object if timeout occurs before the configuration could be read from
    * the admin server.
    * @throws Exception if an exception occurs in the attempt just prior to the timeout
    */
-  private WlsDomainConfig getWlsDomainConfig(String principal, long timeout) throws Exception {
+  private WlsDomainConfig getWlsDomainConfig(long timeout) throws Exception {
     LOGGER.entering();
 
     long stopTime = System.currentTimeMillis() + timeout;
@@ -342,8 +338,7 @@ private WlsDomainConfig getWlsDomainConfig(String principal, long timeout) throw
       LOGGER.info(MessageKeys.WLS_CONFIGURATION_READ_TRYING, timeRemaining);
       exception = null;
       try {
-        connectAdminServer(principal);
-        String serviceURL = HttpClient.getServiceURL(principal, asServiceName, namespace);
+        String serviceURL = connectAndGetServiceURL();
         String jsonResult =
           httpClient.executePostUrlOnServiceClusterIP(WlsDomainConfig.getRetrieveServersSearchUrl(), serviceURL, WlsDomainConfig.getRetrieveServersSearchPayload()).getResponse();
         if (jsonResult != null) {
@@ -370,14 +365,17 @@ private WlsDomainConfig getWlsDomainConfig(String principal, long timeout) throw
   }
 
   /**
-   * Connect to the WebLogic Administration Server.
+   * Connect to the WebLogic Administration Server and returns the service URL
    *
-   * @param principal The principal that should be used to connect to the Admin Server.
+   * @return serviceURL for issuing HTTP requests to the admin server
    */
-  public void connectAdminServer(String principal) {
+  String connectAndGetServiceURL() {
     if (httpClient == null) {
-      httpClient = HttpClient.createAuthenticatedClientForServer(principal, namespace, adminSecretName);
+      httpClient = HttpClient.createAuthenticatedClientForServer(namespace, adminSecretName);
     }
+
+    return HttpClient.getServiceURL(asServiceName, namespace);
   }
 
+
 }