From aefeb9ff5ec5c7ce3c20f420db1116c31f034615 Mon Sep 17 00:00:00 2001 From: Venkata Harish K Kajur Date: Tue, 30 Jan 2018 14:04:13 -0500 Subject: Update the files for ajsc 6 changes Issue-ID: AAI-33 Change-Id: I897566e79eb7505232b692e551f6347e69fafed6 Signed-off-by: Venkata Harish K Kajur --- .../java/org/onap/aai/AAIRibbonConfiguration.java | 54 +++++ .../main/java/org/onap/aai/config/HttpPing.java | 68 ++++++ .../java/org/onap/aai/config/HttpPingImpl.java | 251 +++++++++++++++++++++ 3 files changed, 373 insertions(+) create mode 100644 aai-client-loadbalancer/src/main/java/org/onap/aai/AAIRibbonConfiguration.java create mode 100644 aai-client-loadbalancer/src/main/java/org/onap/aai/config/HttpPing.java create mode 100644 aai-client-loadbalancer/src/main/java/org/onap/aai/config/HttpPingImpl.java (limited to 'aai-client-loadbalancer/src/main/java') diff --git a/aai-client-loadbalancer/src/main/java/org/onap/aai/AAIRibbonConfiguration.java b/aai-client-loadbalancer/src/main/java/org/onap/aai/AAIRibbonConfiguration.java new file mode 100644 index 00000000..4c639e44 --- /dev/null +++ b/aai-client-loadbalancer/src/main/java/org/onap/aai/AAIRibbonConfiguration.java @@ -0,0 +1,54 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017 AT&T Intellectual Property. 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. + * ============LICENSE_END========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai; + +import com.netflix.client.config.IClientConfig; +import com.netflix.loadbalancer.ILoadBalancer; +import com.netflix.loadbalancer.LoadBalancerBuilder; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.cloud.client.loadbalancer.LoadBalanced; +import org.springframework.context.annotation.Bean; +import org.springframework.web.client.RestTemplate; + +/** + * AAIRibbonConfiguration is responsible for configuring the dmaap + * and it reads the users the application properties class + * and is mostly configurable via properties + */ +public class AAIRibbonConfiguration { + + @Autowired + IClientConfig ribbonClientConfig; + + @Bean + public ILoadBalancer ribbonLoadBalancer() { + return LoadBalancerBuilder.newBuilder() + .withClientConfig(ribbonClientConfig) + .buildLoadBalancerFromConfigWithReflection(); + } + + @LoadBalanced + @Bean + public RestTemplate loadBalancedRestTemplate(){ + return new RestTemplate(); + } +} diff --git a/aai-client-loadbalancer/src/main/java/org/onap/aai/config/HttpPing.java b/aai-client-loadbalancer/src/main/java/org/onap/aai/config/HttpPing.java new file mode 100644 index 00000000..4ecbfb60 --- /dev/null +++ b/aai-client-loadbalancer/src/main/java/org/onap/aai/config/HttpPing.java @@ -0,0 +1,68 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017 AT&T Intellectual Property. 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. + * ============LICENSE_END========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.config; + +import java.util.Optional; + +/** + * HttpPing interface provides access to update the endpoint and + * and the security level of the server that the user is trying to access + */ +public interface HttpPing { + + /** + * Sets the endpoint that the http get request will + * make to verify if the url can be reached + * + * @param endpoint - the endpoint of the url that is used to do healthcheck + */ + void setHealthCheckEndpoint(String endpoint); + + /** + * Returns the health check endpoint that the implementation + * will use in order to verify if the server is reachable at that location + * + * @return endpoint - the endpoint of the url that is used to do healthcheck + */ + String getHealthCheckEndpoint(); + + /** + * Set the credentials for the rest endpoint to verify authorization + * + * @param username - the username to the server trying to connect to + * @param password - the password to the server trying to connect to + */ + void setCredentials(String username, String password); + + /** + * Return the base64 authorization string set from the username and password + * + * @return encoded string using base64 of the username and password values + * like this: + * 
+     * @{code
+     *      "username:password" => "Basic dXNlcm5hbWU6cGFzc3dvcmQ="
+     * }
+     *
+ */ + Optional getAuthorization(); +} diff --git a/aai-client-loadbalancer/src/main/java/org/onap/aai/config/HttpPingImpl.java b/aai-client-loadbalancer/src/main/java/org/onap/aai/config/HttpPingImpl.java new file mode 100644 index 00000000..2e5804eb --- /dev/null +++ b/aai-client-loadbalancer/src/main/java/org/onap/aai/config/HttpPingImpl.java @@ -0,0 +1,251 @@ +/** + * ============LICENSE_START======================================================= + * org.onap.aai + * ================================================================================ + * Copyright © 2017 AT&T Intellectual Property. 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. + * ============LICENSE_END========================================================= + * + * ECOMP is a trademark and service mark of AT&T Intellectual Property. + */ +package org.onap.aai.config; + +import com.att.eelf.configuration.EELFLogger; +import com.att.eelf.configuration.EELFManager; +import com.netflix.client.config.DefaultClientConfigImpl; +import com.netflix.client.config.IClientConfig; +import com.netflix.loadbalancer.IPing; +import com.netflix.loadbalancer.Server; +import org.springframework.http.*; +import org.springframework.web.client.HttpClientErrorException; +import org.springframework.web.client.RestTemplate; + +import java.io.IOException; +import java.net.InetSocketAddress; +import java.net.Socket; +import java.net.SocketAddress; +import java.util.Base64; +import java.util.Collections; +import java.util.Map; +import java.util.Optional; + +public class HttpPingImpl implements HttpPing, IPing { + + private static final EELFLogger logger = EELFManager.getInstance().getLogger(HttpPingImpl.class); + + private static final Base64.Encoder base64Encoder = Base64.getEncoder(); + + private static final HttpHeaders HTTP_HEADERS = new HttpHeaders(); + + // This is a workaround for the topics that the user + // does not have the access to read their own topic status + private static final String MR_STATUS_PATTERN = ".*\"mrstatus\":\\s*4002.*"; + + private static final int HTTPS_PORT = 3905; + private static final int DEFAULT_TIMEOUT = 2; + + private String healthCheckEndpoint; + private String username; + private String password; + + private int timeout; + + private final RestTemplate restTemplate; + + public HttpPingImpl(String healthCheckEndpoint) { + this(new RestTemplate()); + this.healthCheckEndpoint = healthCheckEndpoint; + this.timeout = DEFAULT_TIMEOUT; + } + + public HttpPingImpl(RestTemplate restTemplate) { + this.restTemplate = restTemplate; + this.healthCheckEndpoint = ""; + this.timeout = DEFAULT_TIMEOUT; + } + + public HttpPingImpl() { + this(""); + } + + public HttpPingImpl(IClientConfig clientConfig) { + + if (!(clientConfig instanceof DefaultClientConfigImpl)) { + throw new UnsupportedOperationException("Unable to support the client config implementation: " + clientConfig.getClass().getName()); + } + + DefaultClientConfigImpl defaultClientConfig = (DefaultClientConfigImpl) clientConfig; + + Map map = defaultClientConfig.getProperties(); + + this.setCredentials(map.get("username").toString(), map.get("password").toString()); + this.setHealthCheckEndpoint(map.get("health.endpoint").toString()); + this.setTimeoutInSecs(Integer.valueOf(map.get("pingport.timeout").toString())); + + this.restTemplate = new RestTemplate(); + } + + /** + * {@inheritDoc} + */ + @Override + public void setHealthCheckEndpoint(String endpoint) { + this.healthCheckEndpoint = endpoint; + } + + /** + * {@inheritDoc} + */ + @Override + public String getHealthCheckEndpoint() { + return healthCheckEndpoint; + } + + @Override + public void setCredentials(String username, String password) { + this.username = username; + this.password = password; + } + + public void setTimeoutInSecs(int timeout) { + this.timeout = timeout; + } + + @Override + public Optional getAuthorization() { + + if (username == null && password == null) { + return Optional.empty(); + } + + if (username == null || username.isEmpty()) { + logger.error("Username is null while the password is not correctly set"); + return Optional.empty(); + } + + if (password == null || password.isEmpty()) { + logger.error("Password is null while the username is not correctly set"); + return Optional.empty(); + } + + String auth = String.format("%s:%s", username, password); + return Optional.ofNullable("Basic " + base64Encoder.encodeToString(auth.getBytes())); + } + + /** + * @{inheritDoc} + */ + @Override + public boolean isAlive(Server server) { + + String url = null; + + // If unable to ping the port then return immediately + if (!pingPort(server)) { + return false; + } + + if (server.getPort() == HTTPS_PORT) { + url = "https://"; + } else { + + url = "http://"; + } + + url = url + server.getId(); + url = url + this.getHealthCheckEndpoint(); + + boolean isAlive = false; + + Optional authorization = getAuthorization(); + + HttpHeaders httpHeaders = new HttpHeaders(); + httpHeaders.setAccept(Collections.singletonList(MediaType.APPLICATION_JSON)); + + if (authorization.isPresent()) { + httpHeaders.add("Authorization", authorization.get()); + } + + HttpEntity httpEntity = new HttpEntity<>(httpHeaders); + try { + + ResponseEntity responseEntity = restTemplate.exchange(url, HttpMethod.GET, httpEntity, String.class); + + HttpStatus httpStatus = responseEntity.getStatusCode(); + + if (httpStatus == HttpStatus.OK) { + isAlive = true; + logger.info("Successfully established connection to the following url {}", url); + return isAlive; + } + + logger.warn("Unable to establish a connection the following url {} due to HTTP Code {}, and reason {}", + url, httpStatus.value(), httpStatus.getReasonPhrase()); + + } catch (HttpClientErrorException ex) { + HttpStatus httpStatus = ex.getStatusCode(); + if (httpStatus == HttpStatus.FORBIDDEN) { + // This is a workaround being in play for the topics + // that are unable to read themselves for this user + // In the case of the username and password being + // wrong the response would be unauthorized (401) but if the + // user is authorized but unable to read this topic, then + // we get back the (403) with the message mrstatus 4002 + // This is a temporary workaround to properly identify which server is down + String body = ex.getResponseBodyAsString(); + if (body.matches(MR_STATUS_PATTERN)) { + isAlive = true; + logger.info("Successfully connected by workaround due to unable to read own topic {}", url); + return isAlive; + } else { + logger.warn("Unable to establish a connection to {} due to {}", server.getHostPort(), ex.getMessage()); + } + } else { + logger.warn("Unable to establish a connection to {} due to {}", server.getHostPort(), ex.getMessage()); + } + } catch (Exception ex) { + logger.warn("Unable to establish a connection to {} due to {}", server.getHostPort(), ex.getMessage()); + } + + return isAlive; + } + + /** + * Returns true if it can connect to the host and port within + * the given timeout from the given server parameter + * + * @param server - server that will be taken from the src/main/resources/application.yml file + * @return true if it can make a successful socket connection to the port on the host + */ + public boolean pingPort(Server server) { + + String host = server.getHost(); + Integer port = server.getPort(); + + boolean success = false; + SocketAddress socketAddress = new InetSocketAddress(host, port); + + try (Socket socket = new Socket()) { + socket.connect(socketAddress, timeout * 1000); + if (socket.isConnected()) { + success = true; + } + } catch (IOException e) { + logger.warn("Unable to connect to the host {} on port {} due to {}", host, port, e.getLocalizedMessage()); + success = false; + } + + return success; + } +} -- cgit 1.2.3-korg