From 5c4675e5f6f7fe9b8d9e87976ac5f603ff61c268 Mon Sep 17 00:00:00 2001 From: mmis Date: Thu, 22 Mar 2018 14:20:46 +0000 Subject: Removed checkstyle warnings Removed checkstyle warnings in: policy/controlloop/common/guard policy/controlloop/common/msb policy/controlloop/simulators including renaming of the following classes: MSBServiceFactory -> MsbServiceFactory MSBServiceManager -> MsbServiceManager MSBServiceException -> MsbServiceException Issue-ID: POLICY-705 Change-Id: I11d62a74fcb77e764121df119cb0bd9b844b485b Signed-off-by: mmis --- .../policy/msb/client/MSBServiceException.java | 41 ------- .../onap/policy/msb/client/MSBServiceFactory.java | 106 ------------------ .../onap/policy/msb/client/MSBServiceManager.java | 55 ---------- .../policy/msb/client/MsbServiceException.java | 42 +++++++ .../onap/policy/msb/client/MsbServiceFactory.java | 122 +++++++++++++++++++++ .../onap/policy/msb/client/MsbServiceManager.java | 60 ++++++++++ .../main/java/org/onap/policy/msb/client/Node.java | 15 ++- 7 files changed, 231 insertions(+), 210 deletions(-) delete mode 100644 controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MSBServiceException.java delete mode 100644 controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MSBServiceFactory.java delete mode 100644 controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MSBServiceManager.java create mode 100644 controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MsbServiceException.java create mode 100644 controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MsbServiceFactory.java create mode 100644 controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MsbServiceManager.java (limited to 'controlloop/common/msb/src/main/java') diff --git a/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MSBServiceException.java b/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MSBServiceException.java deleted file mode 100644 index 2342e1695..000000000 --- a/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MSBServiceException.java +++ /dev/null @@ -1,41 +0,0 @@ -/******************************************************************************* - * Copyright 2017 ZTE, Inc. and others. - * - * 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 org.onap.policy.msb.client; - -public class MSBServiceException extends Exception { - private static final long serialVersionUID = 5227416822833497317L; - - public MSBServiceException() { - super(); - } - - public MSBServiceException(String message, Throwable cause, boolean enableSuppression, - boolean writableStackTrace) { - super(message, cause, enableSuppression, writableStackTrace); - } - - public MSBServiceException(String message, Throwable cause) { - super(message, cause); - } - - public MSBServiceException(String message) { - super(message); - } - - public MSBServiceException(Throwable cause) { - super(cause); - } - -} diff --git a/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MSBServiceFactory.java b/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MSBServiceFactory.java deleted file mode 100644 index 7ebb5d6dc..000000000 --- a/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MSBServiceFactory.java +++ /dev/null @@ -1,106 +0,0 @@ -/******************************************************************************* - * Copyright 2017 ZTE, Inc. and others. - * - * 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 org.onap.policy.msb.client; - -import java.io.FileInputStream; -import java.io.IOException; -import java.io.InputStream; -import java.io.Serializable; -import java.nio.file.Files; -import java.nio.file.Path; -import java.nio.file.Paths; -import java.util.Properties; - -import org.onap.msb.sdk.discovery.common.RouteException; -import org.onap.msb.sdk.discovery.entity.MicroServiceFullInfo; -import org.onap.msb.sdk.discovery.entity.NodeInfo; -import org.onap.msb.sdk.httpclient.msb.MSBServiceClient; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - - -public class MSBServiceFactory implements Serializable { - private static final long serialVersionUID = 4638414146278012425L; - private static final Logger logger = LoggerFactory.getLogger(MSBServiceFactory.class); - private static final String MSB_PROPERTY_FILE = "msb.policy.properties"; - private static final String MSB_IP = "msb.ip"; - private static final String MSB_PORT = "msb.port"; - private transient MSBServiceClient msbClient; - private Properties properties; - - public MSBServiceFactory() throws MSBServiceException,IOException{ - this.init(); - this.msbClient = new MSBServiceClient(properties.getProperty(MSB_IP), Integer.parseInt(properties.getProperty(MSB_PORT))); - } - public MSBServiceFactory (MSBServiceClient msbClient) { - this.msbClient = msbClient; - } - - private void init() throws MSBServiceException,IOException { - properties = new Properties(); - String propertyFilePath = System.getProperty(MSB_PROPERTY_FILE); - if (propertyFilePath == null) { - throw new MSBServiceException("No msb.policy.properties specified."); - } - Path file = Paths.get(propertyFilePath); - if (!file.toFile().exists()) { - throw new MSBServiceException("No msb.policy.properties specified."); - } - - if (!Files.isReadable(file)) { - throw new MSBServiceException ("Repository is NOT readable: " + file.toAbsolutePath()); - } - try(InputStream is = new FileInputStream(file.toFile())){ - properties.load(is); - } - } - - - public Node getNode(String serviceName,String version){ - return this.build(serviceName,version); - } - - public Node getNode(String actor){ - Node node = null; - switch (actor) { - case "AAI": - node = this.build("aai-search","v11"); - return node; - case "SO": - node = this.build("so","v2"); - return node; - case "VFC": - node = this.build("nfvo-nslcm","v1"); - return node; - default: - logger.info("MSBServiceManager: policy has an unknown actor."); - } - return node; - } - - private Node build(String serviceName,String version){ - Node node = new Node(); - node.setName(serviceName); - try { - MicroServiceFullInfo serviceInfo = msbClient.queryMicroServiceInfo(serviceName,version); - for (NodeInfo nodeInfo: serviceInfo.getNodes()){ - node.setIp(nodeInfo.getIp()); - node.setPort(nodeInfo.getPort()); - } - } catch (RouteException e) { - logger.info("MSBServiceManager:",e); - } - return node; - } -} diff --git a/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MSBServiceManager.java b/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MSBServiceManager.java deleted file mode 100644 index ccb13ece4..000000000 --- a/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MSBServiceManager.java +++ /dev/null @@ -1,55 +0,0 @@ -/******************************************************************************* - * Copyright 2017 ZTE, Inc. and others. - * - * 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 org.onap.policy.msb.client; - -import org.onap.msb.sdk.httpclient.msb.MSBServiceClient; - -import java.io.IOException; -import java.io.Serializable; - -public class MSBServiceManager implements Serializable { - private static final long serialVersionUID = -2517971308551895215L; - private MSBServiceFactory factory; - - public MSBServiceManager() throws MSBServiceException,IOException { - this.factory = new MSBServiceFactory(); - } - - public MSBServiceManager(MSBServiceClient msbClient){ - - this.factory = new MSBServiceFactory(msbClient); - } - - /** - * Get the IP and port of the components registered in the MSB - * @param actor AAI or SO or VFC - * @return - */ - public Node getNode(String actor){ - - return factory.getNode(actor); - } - - /** - * Get the IP and port of the components registered in the MSB - * @param serviceName the service name registered in the MSB - * @param version the service version registered in the MSB - * @return - */ - public Node getNode(String serviceName,String version){ - - return factory.getNode(serviceName,version); - } - -} diff --git a/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MsbServiceException.java b/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MsbServiceException.java new file mode 100644 index 000000000..ebd2e32ff --- /dev/null +++ b/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MsbServiceException.java @@ -0,0 +1,42 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright 2017-2018 ZTE, Inc. and others. + * + * 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.msb.client; + +public class MsbServiceException extends Exception { + private static final long serialVersionUID = 5227416822833497317L; + + public MsbServiceException() { + super(); + } + + public MsbServiceException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) { + super(message, cause, enableSuppression, writableStackTrace); + } + + public MsbServiceException(String message, Throwable cause) { + super(message, cause); + } + + public MsbServiceException(String message) { + super(message); + } + + public MsbServiceException(Throwable cause) { + super(cause); + } + +} diff --git a/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MsbServiceFactory.java b/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MsbServiceFactory.java new file mode 100644 index 000000000..91e36c01d --- /dev/null +++ b/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MsbServiceFactory.java @@ -0,0 +1,122 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright 2017-2018 ZTE, Inc. and others. + * + * 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.msb.client; + +import java.io.FileInputStream; +import java.io.IOException; +import java.io.InputStream; +import java.io.Serializable; +import java.nio.file.Files; +import java.nio.file.Path; +import java.nio.file.Paths; +import java.util.Properties; + +import org.onap.msb.sdk.discovery.common.RouteException; +import org.onap.msb.sdk.discovery.entity.MicroServiceFullInfo; +import org.onap.msb.sdk.discovery.entity.NodeInfo; +import org.onap.msb.sdk.httpclient.msb.MSBServiceClient; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +public class MsbServiceFactory implements Serializable { + private static final long serialVersionUID = 4638414146278012425L; + private static final Logger logger = LoggerFactory.getLogger(MsbServiceFactory.class); + private static final String MSB_PROPERTY_FILE = "msb.policy.properties"; + private static final String MSB_IP = "msb.ip"; + private static final String MSB_PORT = "msb.port"; + private transient MSBServiceClient msbClient; + private Properties properties; + + /** + * Construct an instance. + * + * @throws MsbServiceException if an error occurs + * @throws IOException if an IO error occurs + */ + public MsbServiceFactory() throws MsbServiceException, IOException { + this.init(); + this.msbClient = new MSBServiceClient(properties.getProperty(MSB_IP), + Integer.parseInt(properties.getProperty(MSB_PORT))); + } + + public MsbServiceFactory(MSBServiceClient msbClient) { + this.msbClient = msbClient; + } + + private void init() throws MsbServiceException, IOException { + properties = new Properties(); + String propertyFilePath = System.getProperty(MSB_PROPERTY_FILE); + if (propertyFilePath == null) { + throw new MsbServiceException("No msb.policy.properties specified."); + } + Path file = Paths.get(propertyFilePath); + if (!file.toFile().exists()) { + throw new MsbServiceException("No msb.policy.properties specified."); + } + + if (!Files.isReadable(file)) { + throw new MsbServiceException("Repository is NOT readable: " + file.toAbsolutePath()); + } + try (InputStream is = new FileInputStream(file.toFile())) { + properties.load(is); + } + } + + + public Node getNode(String serviceName, String version) { + return this.build(serviceName, version); + } + + /** + * Get the node for the given actor. + * + * @param actor the actor + * @return the node + */ + public Node getNode(String actor) { + Node node = null; + switch (actor) { + case "AAI": + node = this.build("aai-search", "v11"); + return node; + case "SO": + node = this.build("so", "v2"); + return node; + case "VFC": + node = this.build("nfvo-nslcm", "v1"); + return node; + default: + logger.info("MSBServiceManager: policy has an unknown actor."); + } + return node; + } + + private Node build(String serviceName, String version) { + Node node = new Node(); + node.setName(serviceName); + try { + MicroServiceFullInfo serviceInfo = msbClient.queryMicroServiceInfo(serviceName, version); + for (NodeInfo nodeInfo : serviceInfo.getNodes()) { + node.setIp(nodeInfo.getIp()); + node.setPort(nodeInfo.getPort()); + } + } catch (RouteException e) { + logger.info("MSBServiceManager:", e); + } + return node; + } +} diff --git a/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MsbServiceManager.java b/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MsbServiceManager.java new file mode 100644 index 000000000..aca3ff28f --- /dev/null +++ b/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/MsbServiceManager.java @@ -0,0 +1,60 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright 2017-2018 ZTE, Inc. and others. + * + * 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.msb.client; + +import java.io.IOException; +import java.io.Serializable; + +import org.onap.msb.sdk.httpclient.msb.MSBServiceClient; + +public class MsbServiceManager implements Serializable { + private static final long serialVersionUID = -2517971308551895215L; + private MsbServiceFactory factory; + + public MsbServiceManager() throws MsbServiceException, IOException { + this.factory = new MsbServiceFactory(); + } + + public MsbServiceManager(MSBServiceClient msbClient) { + + this.factory = new MsbServiceFactory(msbClient); + } + + /** + * Get the IP and port of the components registered in the MSB. + * + * @param actor AAI or SO or VFC + * @return the node + */ + public Node getNode(String actor) { + + return factory.getNode(actor); + } + + /** + * Get the IP and port of the components registered in the MSB. + * + * @param serviceName the service name registered in the MSB + * @param version the service version registered in the MSB + * @return the node + */ + public Node getNode(String serviceName, String version) { + + return factory.getNode(serviceName, version); + } + +} diff --git a/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/Node.java b/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/Node.java index 5c06939bf..f42b82e3c 100644 --- a/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/Node.java +++ b/controlloop/common/msb/src/main/java/org/onap/policy/msb/client/Node.java @@ -1,5 +1,6 @@ -/******************************************************************************* - * Copyright 2017 ZTE, Inc. and others. +/*- + * ============LICENSE_START======================================================= + * Copyright 2017-2018 ZTE, Inc. and others. * * 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 @@ -10,7 +11,9 @@ * 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.msb.client; import java.io.Serializable; @@ -47,10 +50,6 @@ public class Node implements Serializable { @Override public String toString() { - return "Node{" + - "name='" + name + '\'' + - ", ip='" + ip + '\'' + - ", port='" + port + '\'' + - '}'; + return "Node{" + "name='" + name + '\'' + ", ip='" + ip + '\'' + ", port='" + port + '\'' + '}'; } } -- cgit 1.2.3-korg