From 7ec767641505f52cd8ecf8b9a76fa35afe32635e Mon Sep 17 00:00:00 2001 From: Sirisha_Manchikanti Date: Mon, 28 Feb 2022 17:10:36 +0000 Subject: Rename ControlLoop to AutomationCompsition Issue-ID: POLICY-3938 Signed-off-by: Sirisha_Manchikanti Change-Id: I63188fa9bc5d634d3aeb7e2d7051c4d67b5a202c --- ...LifecycleApiAutomationCompositionForwarder.java | 121 +++++++++++++++++++++ ...piAutomationCompositionForwarderParameters.java | 48 ++++++++ .../api/LifecycleApiControlLoopForwarder.java | 121 --------------------- ...LifecycleApiControlLoopForwarderParameters.java | 47 -------- 4 files changed, 169 insertions(+), 168 deletions(-) create mode 100644 plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/lifecycle/api/LifecycleApiAutomationCompositionForwarder.java create mode 100644 plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/lifecycle/api/LifecycleApiAutomationCompositionForwarderParameters.java delete mode 100644 plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/lifecycle/api/LifecycleApiControlLoopForwarder.java delete mode 100644 plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/lifecycle/api/LifecycleApiControlLoopForwarderParameters.java (limited to 'plugins/forwarding-plugins/src/main/java') diff --git a/plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/lifecycle/api/LifecycleApiAutomationCompositionForwarder.java b/plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/lifecycle/api/LifecycleApiAutomationCompositionForwarder.java new file mode 100644 index 00000000..99615f50 --- /dev/null +++ b/plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/lifecycle/api/LifecycleApiAutomationCompositionForwarder.java @@ -0,0 +1,121 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2022 Nordix Foundation. + * Modifications Copyright (C) 2022 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.distribution.forwarding.lifecycle.api; + +import java.util.ArrayList; +import java.util.Arrays; +import java.util.Collection; +import java.util.List; +import java.util.Map; +import javax.ws.rs.client.Entity; +import javax.ws.rs.core.HttpHeaders; +import javax.ws.rs.core.MediaType; +import javax.ws.rs.core.Response; +import org.onap.policy.common.endpoints.http.client.HttpClient; +import org.onap.policy.common.endpoints.http.client.HttpClientConfigException; +import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance; +import org.onap.policy.common.parameters.ParameterService; +import org.onap.policy.distribution.forwarding.PolicyForwarder; +import org.onap.policy.distribution.forwarding.PolicyForwardingException; +import org.onap.policy.models.tosca.authorative.concepts.ToscaEntity; +import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +/** + * This class provides an implementation of {@link PolicyForwarder} interface for forwarding the + * automationComposition design template to the life cycle api's of automationComposition components. + * + * @author Sirisha Manchikanti (sirisha.manchikanti@est.tech) + */ +public class LifecycleApiAutomationCompositionForwarder implements PolicyForwarder { + + private static final String COMMISSION_AUTOMATION_COMPOSITION_URI = "/onap/acm/v2/commission"; + private static final Logger LOGGER = LoggerFactory.getLogger(LifecycleApiAutomationCompositionForwarder.class); + + private LifecycleApiAutomationCompositionForwarderParameters forwarderParameters; + private HttpClient automationCompositionClient; + + /** + * {@inheritDoc}. + */ + @Override + public void configure(final String parameterGroupName) throws HttpClientConfigException { + forwarderParameters = ParameterService.get(parameterGroupName); + + automationCompositionClient = HttpClientFactoryInstance.getClientFactory().build( + forwarderParameters.getAutomationCompositionRuntimeParameters()); + } + + /** + * {@inheritDoc}. + */ + @Override + public void forward(final Collection entities) throws PolicyForwardingException { + final List failedEntities = new ArrayList<>(); + for (final ToscaEntity entity : entities) { + forwardSingleEntity(failedEntities, entity); + } + if (!failedEntities.isEmpty()) { + throw new PolicyForwardingException( + "Failed forwarding the following entities: " + Arrays.toString(failedEntities.toArray())); + } + } + + private void forwardSingleEntity(final List failedEntities, final ToscaEntity entity) { + try { + if (entity instanceof ToscaServiceTemplate) { + final var toscaServiceTemplate = (ToscaServiceTemplate) entity; + if (null != toscaServiceTemplate.getToscaTopologyTemplate() + && null != toscaServiceTemplate.getNodeTypes() + && null != toscaServiceTemplate.getDataTypes()) { + commissionAutomationComposition(toscaServiceTemplate); + } + } else { + throw new PolicyForwardingException("The entity is not of type ToscaServiceTemplate - " + entity); + } + } catch (final Exception exp) { + LOGGER.error(exp.getMessage(), exp); + failedEntities.add(entity); + } + } + + private Response commissionAutomationComposition(final ToscaServiceTemplate toscaServiceTemplate) + throws PolicyForwardingException { + return invokeHttpClient(Entity.entity(toscaServiceTemplate, MediaType.APPLICATION_JSON), + COMMISSION_AUTOMATION_COMPOSITION_URI); + } + + private Response invokeHttpClient(final Entity entity, final String path) + throws PolicyForwardingException { + var response = automationCompositionClient.post(path, entity, Map.of(HttpHeaders.ACCEPT, + MediaType.APPLICATION_JSON, HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON)); + if (response.getStatus() / 100 != 2) { + LOGGER.error( + "Invocation of path {} failed for entity {}. Response status: {}, Response status info: {}", + path, entity, response.getStatus(), response.getStatusInfo()); + throw new PolicyForwardingException("Failed creating the entity - " + entity); + } + return response; + } +} + diff --git a/plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/lifecycle/api/LifecycleApiAutomationCompositionForwarderParameters.java b/plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/lifecycle/api/LifecycleApiAutomationCompositionForwarderParameters.java new file mode 100644 index 00000000..be7c5263 --- /dev/null +++ b/plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/lifecycle/api/LifecycleApiAutomationCompositionForwarderParameters.java @@ -0,0 +1,48 @@ +/*- + * ============LICENSE_START======================================================= + * Copyright (C) 2022 Nordix Foundation. + * Modifications Copyright (C) 2022 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.distribution.forwarding.lifecycle.api; + +import lombok.Getter; +import org.onap.policy.common.endpoints.parameters.RestClientParameters; +import org.onap.policy.common.parameters.annotations.NotBlank; +import org.onap.policy.common.parameters.annotations.NotNull; +import org.onap.policy.common.parameters.annotations.Valid; +import org.onap.policy.distribution.main.parameters.PolicyForwarderConfigurationParameterGroup; + +/** + * Holds the parameters for the {@link LifecycleApiAutomationCompositionForwarder}. + * + * @author Sirisha Manchikanti (sirisha.manchikanti@est.tech) + */ +@Getter +@NotNull +@NotBlank +public class LifecycleApiAutomationCompositionForwarderParameters extends PolicyForwarderConfigurationParameterGroup { + public static final String AUTOMATION_COMPOSITION_FORWARDER_PLUGIN_CLASS = + LifecycleApiAutomationCompositionForwarder.class.getName(); + + private @Valid RestClientParameters automationCompositionRuntimeParameters; + + public LifecycleApiAutomationCompositionForwarderParameters() { + super(LifecycleApiAutomationCompositionForwarderParameters.class.getSimpleName()); + } +} diff --git a/plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/lifecycle/api/LifecycleApiControlLoopForwarder.java b/plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/lifecycle/api/LifecycleApiControlLoopForwarder.java deleted file mode 100644 index 605c68cd..00000000 --- a/plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/lifecycle/api/LifecycleApiControlLoopForwarder.java +++ /dev/null @@ -1,121 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2022 Nordix Foundation. - * Modifications Copyright (C) 2022 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.distribution.forwarding.lifecycle.api; - -import java.util.ArrayList; -import java.util.Arrays; -import java.util.Collection; -import java.util.List; -import java.util.Map; -import javax.ws.rs.client.Entity; -import javax.ws.rs.core.HttpHeaders; -import javax.ws.rs.core.MediaType; -import javax.ws.rs.core.Response; -import org.onap.policy.common.endpoints.http.client.HttpClient; -import org.onap.policy.common.endpoints.http.client.HttpClientConfigException; -import org.onap.policy.common.endpoints.http.client.HttpClientFactoryInstance; -import org.onap.policy.common.parameters.ParameterService; -import org.onap.policy.distribution.forwarding.PolicyForwarder; -import org.onap.policy.distribution.forwarding.PolicyForwardingException; -import org.onap.policy.models.tosca.authorative.concepts.ToscaEntity; -import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; - -/** - * This class provides an implementation of {@link PolicyForwarder} interface for forwarding the - * controlloop design template to the life cycle api's of controlloop components. - * - * @author Sirisha Manchikanti (sirisha.manchikanti@est.tech) - */ -public class LifecycleApiControlLoopForwarder implements PolicyForwarder { - - private static final String COMMISSION_CONTROLLOOP_URI = "/onap/controlloop/v2/commission"; - private static final Logger LOGGER = LoggerFactory.getLogger(LifecycleApiControlLoopForwarder.class); - - private LifecycleApiControlLoopForwarderParameters forwarderParameters; - private HttpClient controlLoopClient; - - /** - * {@inheritDoc}. - */ - @Override - public void configure(final String parameterGroupName) throws HttpClientConfigException { - forwarderParameters = ParameterService.get(parameterGroupName); - - controlLoopClient = HttpClientFactoryInstance.getClientFactory().build( - forwarderParameters.getControlLoopRuntimeParameters()); - } - - /** - * {@inheritDoc}. - */ - @Override - public void forward(final Collection entities) throws PolicyForwardingException { - final List failedEntities = new ArrayList<>(); - for (final ToscaEntity entity : entities) { - forwardSingleEntity(failedEntities, entity); - } - if (!failedEntities.isEmpty()) { - throw new PolicyForwardingException( - "Failed forwarding the following entities: " + Arrays.toString(failedEntities.toArray())); - } - } - - private void forwardSingleEntity(final List failedEntities, final ToscaEntity entity) { - try { - if (entity instanceof ToscaServiceTemplate) { - final var toscaServiceTemplate = (ToscaServiceTemplate) entity; - if (null != toscaServiceTemplate.getToscaTopologyTemplate() - && null != toscaServiceTemplate.getNodeTypes() - && null != toscaServiceTemplate.getDataTypes()) { - commissionControlLoop(toscaServiceTemplate); - } - } else { - throw new PolicyForwardingException("The entity is not of type ToscaServiceTemplate - " + entity); - } - } catch (final Exception exp) { - LOGGER.error(exp.getMessage(), exp); - failedEntities.add(entity); - } - } - - private Response commissionControlLoop(final ToscaServiceTemplate toscaServiceTemplate) - throws PolicyForwardingException { - return invokeHttpClient(Entity.entity(toscaServiceTemplate, MediaType.APPLICATION_JSON), - COMMISSION_CONTROLLOOP_URI); - } - - private Response invokeHttpClient(final Entity entity, final String path) - throws PolicyForwardingException { - var response = controlLoopClient.post(path, entity, Map.of(HttpHeaders.ACCEPT, - MediaType.APPLICATION_JSON, HttpHeaders.CONTENT_TYPE, MediaType.APPLICATION_JSON)); - if (response.getStatus() / 100 != 2) { - LOGGER.error( - "Invocation of path {} failed for entity {}. Response status: {}, Response status info: {}", - path, entity, response.getStatus(), response.getStatusInfo()); - throw new PolicyForwardingException("Failed creating the entity - " + entity); - } - return response; - } -} - diff --git a/plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/lifecycle/api/LifecycleApiControlLoopForwarderParameters.java b/plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/lifecycle/api/LifecycleApiControlLoopForwarderParameters.java deleted file mode 100644 index d1abce71..00000000 --- a/plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/lifecycle/api/LifecycleApiControlLoopForwarderParameters.java +++ /dev/null @@ -1,47 +0,0 @@ -/*- - * ============LICENSE_START======================================================= - * Copyright (C) 2022 Nordix Foundation. - * Modifications Copyright (C) 2022 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.distribution.forwarding.lifecycle.api; - -import lombok.Getter; -import org.onap.policy.common.endpoints.parameters.RestClientParameters; -import org.onap.policy.common.parameters.annotations.NotBlank; -import org.onap.policy.common.parameters.annotations.NotNull; -import org.onap.policy.common.parameters.annotations.Valid; -import org.onap.policy.distribution.main.parameters.PolicyForwarderConfigurationParameterGroup; - -/** - * Holds the parameters for the {@link LifecycleApiControlLoopForwarder}. - * - * @author Sirisha Manchikanti (sirisha.manchikanti@est.tech) - */ -@Getter -@NotNull -@NotBlank -public class LifecycleApiControlLoopForwarderParameters extends PolicyForwarderConfigurationParameterGroup { - public static final String CONTROLLOOP_FORWARDER_PLUGIN_CLASS = LifecycleApiControlLoopForwarder.class.getName(); - - private @Valid RestClientParameters controlLoopRuntimeParameters; - - public LifecycleApiControlLoopForwarderParameters() { - super(LifecycleApiControlLoopForwarderParameters.class.getSimpleName()); - } -} -- cgit 1.2.3-korg