diff options
author | Jim Hahn <jrh3@att.com> | 2019-07-10 16:10:49 -0400 |
---|---|---|
committer | Jim Hahn <jrh3@att.com> | 2019-07-10 16:12:21 -0400 |
commit | e6f7f7e85036a73c3d8f931a5a3aa9f6a1835abd (patch) | |
tree | 3f4438e09aeafb85705b5ca814ee0b449a5958ce | |
parent | a593d0931f9a5785572bb52c5dfae32faa5d8116 (diff) |
Fix checkstyle issues in feature-healthcheck
Also deleted the checkstyle suppression file.
Change-Id: I44b5eaac4b75a7fc2186066d2bb109752a9e2e0f
Issue-ID: POLICY-1904
Signed-off-by: Jim Hahn <jrh3@att.com>
4 files changed, 251 insertions, 246 deletions
diff --git a/feature-healthcheck/checkstyle-suppressions.xml b/feature-healthcheck/checkstyle-suppressions.xml deleted file mode 100644 index ed04d894..00000000 --- a/feature-healthcheck/checkstyle-suppressions.xml +++ /dev/null @@ -1,30 +0,0 @@ -<?xml version="1.0"?> -<!-- - ============LICENSE_START======================================================= - Copyright (C) 2018 AT&T Technologies. 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. - - SPDX-License-Identifier: Apache-2.0 - ============LICENSE_END========================================================= ---> - -<!DOCTYPE suppressions PUBLIC - "-//Puppy Crawl//DTD Suppressions 1.0//EN" - "http://www.puppycrawl.com/dtds/suppressions_1_0.dtd"> - -<suppressions> - <suppress checks="OneTopLevelClass" - files="HealthCheck.java" - lines="1-9999"/> -</suppressions> diff --git a/feature-healthcheck/pom.xml b/feature-healthcheck/pom.xml index eec0b622..a4385f77 100644 --- a/feature-healthcheck/pom.xml +++ b/feature-healthcheck/pom.xml @@ -2,7 +2,7 @@ ============LICENSE_START======================================================= ONAP Policy Engine - Drools PDP ================================================================================ - Copyright (C) 2017-2018 AT&T Intellectual Property. All rights reserved. + Copyright (C) 2017-2019 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. @@ -105,7 +105,6 @@ <includeTestResources>true</includeTestResources> <excludes> </excludes> - <suppressionsLocation>${project.baseUri}checkstyle-suppressions.xml</suppressionsLocation> <consoleOutput>true</consoleOutput> <failsOnViolation>true</failsOnViolation> <violationSeverity>warning</violationSeverity> diff --git a/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/HealthCheck.java b/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/HealthCheck.java index d7009be9..1a4dab6b 100644 --- a/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/HealthCheck.java +++ b/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/HealthCheck.java @@ -22,19 +22,7 @@ package org.onap.policy.drools.healthcheck; import java.util.ArrayList; import java.util.List; -import java.util.Properties; -import javax.ws.rs.core.Response; import org.onap.policy.common.capabilities.Startable; -import org.onap.policy.common.endpoints.http.client.HttpClient; -import org.onap.policy.common.endpoints.http.client.HttpClientFactory; -import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance; -import org.onap.policy.common.endpoints.http.server.HttpServletServer; -import org.onap.policy.common.endpoints.http.server.HttpServletServerFactory; -import org.onap.policy.common.endpoints.http.server.HttpServletServerFactoryInstance; -import org.onap.policy.drools.persistence.SystemPersistence; -import org.onap.policy.drools.system.PolicyEngine; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; /** * Healthcheck. @@ -175,205 +163,3 @@ public interface HealthCheck extends Startable { */ public Reports healthCheck(); } - - -/** - * Healthcheck Monitor. - */ -class HealthCheckMonitor implements HealthCheck { - - /** - * Logger. - */ - private static Logger logger = LoggerFactory.getLogger(HealthCheckMonitor.class); - - /** - * Attached http servers. - */ - protected volatile List<HttpServletServer> servers = new ArrayList<>(); - - /** - * Attached http clients. - */ - protected volatile List<HttpClient> clients = new ArrayList<>(); - - /** - * Healthcheck configuration. - */ - protected volatile Properties healthCheckProperties = null; - - /** - * {@inheritDoc}. - */ - @Override - public Reports healthCheck() { - Reports reports = new Reports(); - boolean thisEngineIsAlive = getEngineManager().isAlive(); - reports.setHealthy(thisEngineIsAlive); - - HealthCheck.Report engineReport = new Report(); - engineReport.setHealthy(thisEngineIsAlive); - engineReport.setName("PDP-D"); - engineReport.setUrl("self"); - engineReport.setCode(thisEngineIsAlive ? 200 : 500); - engineReport.setMessage(thisEngineIsAlive ? "alive" : "not alive"); - reports.getDetails().add(engineReport); - - for (HttpClient client : clients) { - HealthCheck.Report report = new Report(); - report.setName(client.getName()); - report.setUrl(client.getBaseUrl()); - report.setHealthy(true); - try { - Response response = client.get(); - report.setCode(response.getStatus()); - if (report.getCode() != 200) { - report.setHealthy(false); - reports.setHealthy(false); - } - - report.setMessage(getHttpBody(response, client)); - } catch (Exception e) { - logger.warn("{}: cannot contact http-client {}", this, client, e); - - report.setHealthy(false); - reports.setHealthy(false); - } - reports.getDetails().add(report); - } - return reports; - } - - /** - * {@inheritDoc}. - */ - @Override - public boolean start() { - - try { - this.healthCheckProperties = getPersistentProperties(HealthCheckFeature.CONFIGURATION_PROPERTIES_NAME); - this.servers = getServerFactory().build(healthCheckProperties); - this.clients = getClientFactory().build(healthCheckProperties); - - for (HttpServletServer server : servers) { - if (server.isAaf()) { - server.addFilterClass(null, AafHealthCheckFilter.class.getName()); - } - startServer(server); - } - } catch (Exception e) { - logger.warn("{}: cannot start {}", this, e); - return false; - } - - return true; - } - - /** - * {@inheritDoc}. - */ - @Override - public boolean stop() { - - for (HttpServletServer server : servers) { - try { - server.stop(); - } catch (Exception e) { - logger.warn("{}: cannot stop http-server {}", this, server, e); - } - } - - for (HttpClient client : clients) { - try { - client.stop(); - } catch (Exception e) { - logger.warn("{}: cannot stop http-client {}", this, client, e); - } - } - - return true; - } - - /** - * {@inheritDoc}. - */ - @Override - public void shutdown() { - this.stop(); - } - - /** - * {@inheritDoc}. - */ - @Override - public synchronized boolean isAlive() { - return this.healthCheckProperties != null; - } - - /** - * Get servers. - * - * @return list of attached Http Servers - */ - public List<HttpServletServer> getServers() { - return this.servers; - } - - /** - * Get clients. - * - * @return list of attached Http Clients - */ - public List<HttpClient> getClients() { - return this.clients; - } - - public String getHttpBody(Response response, HttpClient client) { - - String body = null; - try { - body = HttpClient.getBody(response, String.class); - } catch (Exception e) { - logger.info("{}: cannot get body from http-client {}", this, client, e); - } - - return body; - } - - public void startServer(HttpServletServer server) { - try { - server.start(); - } catch (Exception e) { - logger.warn("{}: cannot start http-server {}", this, server, e); - } - } - - @Override - public String toString() { - StringBuilder builder = new StringBuilder(); - builder.append("HealthCheckMonitor [servers="); - builder.append(servers); - builder.append(", clients="); - builder.append(clients); - builder.append("]"); - return builder.toString(); - } - - // the following methods may be overridden by junit tests - - protected PolicyEngine getEngineManager() { - return PolicyEngine.manager; - } - - protected HttpServletServerFactory getServerFactory() { - return HttpServletServerFactoryInstance.getServerFactory(); - } - - protected HttpClientFactory getClientFactory() { - return HttpClientFactoryInstance.getClientFactory(); - } - - protected Properties getPersistentProperties(String propertyName) { - return SystemPersistence.manager.getProperties(propertyName); - } -} diff --git a/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/HealthCheckMonitor.java b/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/HealthCheckMonitor.java new file mode 100644 index 00000000..cca56e01 --- /dev/null +++ b/feature-healthcheck/src/main/java/org/onap/policy/drools/healthcheck/HealthCheckMonitor.java @@ -0,0 +1,250 @@ +/* + * ============LICENSE_START======================================================= + * ONAP + * ================================================================================ + * Copyright (C) 2019 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========================================================= + */ + +package org.onap.policy.drools.healthcheck; + +import java.util.ArrayList; +import java.util.List; +import java.util.Properties; +import javax.ws.rs.core.Response; +import org.onap.policy.common.endpoints.http.client.HttpClient; +import org.onap.policy.common.endpoints.http.client.HttpClientFactory; +import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance; +import org.onap.policy.common.endpoints.http.server.HttpServletServer; +import org.onap.policy.common.endpoints.http.server.HttpServletServerFactory; +import org.onap.policy.common.endpoints.http.server.HttpServletServerFactoryInstance; +import org.onap.policy.drools.persistence.SystemPersistence; +import org.onap.policy.drools.system.PolicyEngine; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + + +/** + * Healthcheck Monitor. + */ +public class HealthCheckMonitor implements HealthCheck { + + /** + * Logger. + */ + private static Logger logger = LoggerFactory.getLogger(HealthCheckMonitor.class); + + /** + * Attached http servers. + */ + protected List<HttpServletServer> servers = new ArrayList<>(); + + /** + * Attached http clients. + */ + protected List<HttpClient> clients = new ArrayList<>(); + + /** + * Healthcheck configuration. + */ + protected Properties healthCheckProperties = null; + + /** + * {@inheritDoc}. + */ + @Override + public Reports healthCheck() { + Reports reports = new Reports(); + boolean thisEngineIsAlive = getEngineManager().isAlive(); + reports.setHealthy(thisEngineIsAlive); + + HealthCheck.Report engineReport = new Report(); + engineReport.setHealthy(thisEngineIsAlive); + engineReport.setName("PDP-D"); + engineReport.setUrl("self"); + engineReport.setCode(thisEngineIsAlive ? 200 : 500); + engineReport.setMessage(thisEngineIsAlive ? "alive" : "not alive"); + reports.getDetails().add(engineReport); + + for (HttpClient client : clients) { + HealthCheck.Report report = new Report(); + report.setName(client.getName()); + report.setUrl(client.getBaseUrl()); + report.setHealthy(true); + try { + Response response = client.get(); + report.setCode(response.getStatus()); + if (report.getCode() != 200) { + report.setHealthy(false); + reports.setHealthy(false); + } + + report.setMessage(getHttpBody(response, client)); + } catch (Exception e) { + logger.warn("{}: cannot contact http-client {}", this, client, e); + + report.setHealthy(false); + reports.setHealthy(false); + } + reports.getDetails().add(report); + } + return reports; + } + + /** + * {@inheritDoc}. + */ + @Override + public boolean start() { + + try { + this.healthCheckProperties = getPersistentProperties(HealthCheckFeature.CONFIGURATION_PROPERTIES_NAME); + this.servers = getServerFactory().build(healthCheckProperties); + this.clients = getClientFactory().build(healthCheckProperties); + + for (HttpServletServer server : servers) { + if (server.isAaf()) { + server.addFilterClass(null, AafHealthCheckFilter.class.getName()); + } + startServer(server); + } + } catch (Exception e) { + logger.warn("{}: cannot start {}", this, e); + return false; + } + + return true; + } + + /** + * {@inheritDoc}. + */ + @Override + public boolean stop() { + + for (HttpServletServer server : servers) { + try { + server.stop(); + } catch (Exception e) { + logger.warn("{}: cannot stop http-server {}", this, server, e); + } + } + + for (HttpClient client : clients) { + try { + client.stop(); + } catch (Exception e) { + logger.warn("{}: cannot stop http-client {}", this, client, e); + } + } + + return true; + } + + /** + * {@inheritDoc}. + */ + @Override + public void shutdown() { + this.stop(); + } + + /** + * {@inheritDoc}. + */ + @Override + public synchronized boolean isAlive() { + return this.healthCheckProperties != null; + } + + /** + * Get servers. + * + * @return list of attached Http Servers + */ + public List<HttpServletServer> getServers() { + return this.servers; + } + + /** + * Get clients. + * + * @return list of attached Http Clients + */ + public List<HttpClient> getClients() { + return this.clients; + } + + /** + * Gets the body from the response. + * + * @param response response from which to get the body + * @param client HTTP client from which the response was received + * @return the response body + */ + public String getHttpBody(Response response, HttpClient client) { + + String body = null; + try { + body = HttpClient.getBody(response, String.class); + } catch (Exception e) { + logger.info("{}: cannot get body from http-client {}", this, client, e); + } + + return body; + } + + /** + * Starts an HTTP server. + * + * @param server server to be started + */ + public void startServer(HttpServletServer server) { + try { + server.start(); + } catch (Exception e) { + logger.warn("{}: cannot start http-server {}", this, server, e); + } + } + + @Override + public String toString() { + StringBuilder builder = new StringBuilder(); + builder.append("HealthCheckMonitor [servers="); + builder.append(servers); + builder.append(", clients="); + builder.append(clients); + builder.append("]"); + return builder.toString(); + } + + // the following methods may be overridden by junit tests + + protected PolicyEngine getEngineManager() { + return PolicyEngine.manager; + } + + protected HttpServletServerFactory getServerFactory() { + return HttpServletServerFactoryInstance.getServerFactory(); + } + + protected HttpClientFactory getClientFactory() { + return HttpClientFactoryInstance.getClientFactory(); + } + + protected Properties getPersistentProperties(String propertyName) { + return SystemPersistence.manager.getProperties(propertyName); + } +} |