From 115a58a8c55d9dd1230b7373686f7934d40b2629 Mon Sep 17 00:00:00 2001 From: "a.sreekumar" Date: Wed, 26 Jun 2019 10:52:28 +0000 Subject: Adding Topic and REST parameters to policy-endpoints 1) Adding Topic parameters and REST parameters into policy-endpoints module as these are used by other modules such as PAP, APEX and XACML PDPs. 2) ParameterUtils class is also added which can contain related utility methods Change-Id: I5421fbf2234259305e3626ec0859aee0f36ed9b1 Issue-ID: POLICY-1744 Signed-off-by: a.sreekumar --- .../endpoints/parameters/RestServerParameters.java | 52 +++++++++++++++ .../endpoints/parameters/TopicParameterGroup.java | 47 +++++++++++++ .../endpoints/parameters/TopicParameters.java | 44 +++++++++++++ .../common/endpoints/utils/ParameterUtils.java | 77 ++++++++++++++++++++++ 4 files changed, 220 insertions(+) create mode 100644 policy-endpoints/src/main/java/org/onap/policy/common/endpoints/parameters/RestServerParameters.java create mode 100644 policy-endpoints/src/main/java/org/onap/policy/common/endpoints/parameters/TopicParameterGroup.java create mode 100644 policy-endpoints/src/main/java/org/onap/policy/common/endpoints/parameters/TopicParameters.java create mode 100644 policy-endpoints/src/main/java/org/onap/policy/common/endpoints/utils/ParameterUtils.java (limited to 'policy-endpoints/src/main') diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/parameters/RestServerParameters.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/parameters/RestServerParameters.java new file mode 100644 index 00000000..85f1f455 --- /dev/null +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/parameters/RestServerParameters.java @@ -0,0 +1,52 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2019 Nordix Foundation. + * ================================================================================ + * 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========================================================= + */ + +package org.onap.policy.common.endpoints.parameters; + +import lombok.Getter; + +import org.onap.policy.common.parameters.ParameterGroupImpl; +import org.onap.policy.common.parameters.annotations.Min; +import org.onap.policy.common.parameters.annotations.NotBlank; +import org.onap.policy.common.parameters.annotations.NotNull; + +/** + * Class to hold all parameters needed for rest server. + * + * @author Ajith Sreekumar (ajith.sreekumar@est.tech) + */ +@NotNull +@NotBlank +@Getter +public class RestServerParameters extends ParameterGroupImpl { + private String host; + + @Min(value = 1) + private int port; + + private String userName; + private String password; + private boolean https; + private boolean aaf; + + public RestServerParameters() { + super(RestServerParameters.class.getSimpleName()); + } +} diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/parameters/TopicParameterGroup.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/parameters/TopicParameterGroup.java new file mode 100644 index 00000000..3cc2503a --- /dev/null +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/parameters/TopicParameterGroup.java @@ -0,0 +1,47 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2019 Nordix Foundation. + * ================================================================================ + * 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========================================================= + */ + +package org.onap.policy.common.endpoints.parameters; + +import java.util.List; +import lombok.Getter; +import lombok.Setter; +import org.onap.policy.common.parameters.ParameterGroupImpl; +import org.onap.policy.common.parameters.annotations.NotBlank; +import org.onap.policy.common.parameters.annotations.NotNull; + +/** + * Class to hold all parameters needed for topic properties. + * + * @author Ajith Sreekumar (ajith.sreekumar@est.tech) + */ +@NotNull +@NotBlank +@Getter +@Setter +public class TopicParameterGroup extends ParameterGroupImpl { + + private List topicSources; + private List topicSinks; + + public TopicParameterGroup() { + super(TopicParameterGroup.class.getSimpleName()); + } +} diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/parameters/TopicParameters.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/parameters/TopicParameters.java new file mode 100644 index 00000000..82c75d35 --- /dev/null +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/parameters/TopicParameters.java @@ -0,0 +1,44 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2019 Nordix Foundation. + * ================================================================================ + * 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========================================================= + */ + +package org.onap.policy.common.endpoints.parameters; + +import java.util.List; +import lombok.EqualsAndHashCode; +import lombok.Getter; +import lombok.Setter; +import org.onap.policy.common.parameters.annotations.NotBlank; +import org.onap.policy.common.parameters.annotations.NotNull; + +/** + * Class to hold topic details such as name, server and topicCommInfrastructure. + * + * @author Ajith Sreekumar (ajith.sreekumar@est.tech) + */ +@NotNull +@NotBlank +@Getter +@Setter +@EqualsAndHashCode +public class TopicParameters { + private String topic; + private List servers; + private String topicCommInfrastructure; +} diff --git a/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/utils/ParameterUtils.java b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/utils/ParameterUtils.java new file mode 100644 index 00000000..9e7c69a4 --- /dev/null +++ b/policy-endpoints/src/main/java/org/onap/policy/common/endpoints/utils/ParameterUtils.java @@ -0,0 +1,77 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2019 Nordix Foundation. + * ================================================================================ + * 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========================================================= + */ + +package org.onap.policy.common.endpoints.utils; + +import java.util.List; +import java.util.Properties; + +import org.onap.policy.common.endpoints.parameters.TopicParameterGroup; +import org.onap.policy.common.endpoints.parameters.TopicParameters; + +/** + * This is common utility class with utility methods for parameters. + * + * @author Ajith Sreekumar (ajith.sreekumar@est.tech) + */ +public abstract class ParameterUtils { + + /** + * Private constructor used to prevent sub class instantiation. + */ + private ParameterUtils() { + // Prevent construction of this class + } + + /** + * Create topic properties object from the parameters. + * + * @param topicParameters the topic parameters read from config file + * @return the topic properties object + */ + public static Properties getTopicProperties(TopicParameterGroup topicParameters) { + Properties topicProperties = new Properties(); + List topicSources = topicParameters.getTopicSources(); + List topicSinks = topicParameters.getTopicSinks(); + + // for each topicCommInfrastructure, there could be multiple topics (specified as comma separated string) + // for each such topics, there could be multiple servers (specified as comma separated string) + for (TopicParameters source : topicSources) { + addTopicProperties(topicProperties, ".source.topics", source); + } + for (TopicParameters sink : topicSinks) { + addTopicProperties(topicProperties, ".sink.topics", sink); + } + + return topicProperties; + } + + private static void addTopicProperties(Properties topicProperties, String keyName, TopicParameters topicParameter) { + String propKey = topicParameter.getTopicCommInfrastructure() + keyName; + if (topicProperties.containsKey(propKey)) { + topicProperties.setProperty(propKey, + topicProperties.getProperty(propKey) + "," + topicParameter.getTopic()); + } else { + topicProperties.setProperty(propKey, topicParameter.getTopic()); + } + topicProperties.setProperty(propKey + "." + topicParameter.getTopic() + ".servers", + String.join(",", topicParameter.getServers())); + } +} -- cgit 1.2.3-korg