aai-client-loadbalancer/src/main/java/org/onap/aai/config/HttpPing.java

   1 /**
   2  * ============LICENSE_START=======================================================
   3  * org.onap.aai
   4  * ================================================================================
   5  * Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *    http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  *
  20  * ECOMP is a trademark and service mark of AT&T Intellectual Property.
  21  */
  22 package org.onap.aai.config;
  23
  24 import java.util.Optional;
  25
  26 /**
  27  * <b>HttpPing</b> interface provides access to update the endpoint and
  28  * and the security level of the server that the user is trying to access
  29  */
  30 public interface HttpPing {
  31
  32     /**
  33      * Sets the endpoint that the http get request will
  34      * make to verify if the url can be reached
  35      *
  36      * @param endpoint - the endpoint of the url that is used to do healthcheck
  37      */
  38     void setHealthCheckEndpoint(String endpoint);
  39
  40     /**
  41      * Returns the health check endpoint that the implementation
  42      * will use in order to verify if the server is reachable at that location
  43      *
  44      * @return endpoint - the endpoint of the url that is used to do healthcheck
  45      */
  46     String getHealthCheckEndpoint();
  47
  48     /**
  49      * Set the credentials for the rest endpoint to verify authorization
  50      *
  51      * @param username - the username to the server trying to connect to
  52      * @param password - the password to the server trying to connect to
  53      */
  54     void setCredentials(String username, String password);
  55
  56     /**
  57      * Return the base64 authorization string set from the username and password
  58      *
  59      * @return encoded string using base64 of the username and password values
  60      * like this:
  61      * <pre>
  62      * @{code
  63      *      "username:password" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ="
  64      * }
  65      * </pre>
  66      */
  67     Optional<String> getAuthorization();
  68 }