gerrit.onap Code Review - policy/distribution.git/blob

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2018 Ericsson. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  *
  17  * SPDX-License-Identifier: Apache-2.0
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.onap.policy.distribution.reception.handling;
  22
  23 import java.util.ArrayList;
  24 import java.util.Collection;
  25
  26 import org.onap.policy.common.logging.flexlogger.FlexLogger;
  27 import org.onap.policy.common.logging.flexlogger.Logger;
  28 import org.onap.policy.common.parameters.ParameterService;
  29 import org.onap.policy.distribution.forwarding.PolicyForwarder;
  30 import org.onap.policy.distribution.forwarding.PolicyForwardingException;
  31 import org.onap.policy.distribution.model.Policy;
  32 import org.onap.policy.distribution.model.PolicyInput;
  33 import org.onap.policy.distribution.reception.decoding.PluginInitializationException;
  34 import org.onap.policy.distribution.reception.decoding.PolicyDecoder;
  35 import org.onap.policy.distribution.reception.decoding.PolicyDecodingException;
  36 import org.onap.policy.distribution.reception.parameters.ReceptionHandlerParameters;
  37
  38 /**
  39  * Base implementation of {@link ReceptionHandler}. All reception handlers should extend this base class by implementing
  40  * the {@link #initializeReception(String)} method to perform the specific initialization required to receive inputs and
  41  * by invoking {@link #inputReceived(PolicyInput)} when the reception handler receives input.
  42  */
  43 public abstract class AbstractReceptionHandler implements ReceptionHandler {
  44
  45     private static final Logger LOGGER = FlexLogger.getLogger(AbstractReceptionHandler.class);
  46
  47     private PluginHandler pluginHandler;
  48
  49     /**
  50      * {@inheritDoc}.
  51      */
  52     @Override
  53     public void initialize(final String parameterGroupName) throws PluginInitializationException {
  54         final ReceptionHandlerParameters receptionHandlerParameters = ParameterService.get(parameterGroupName);
  55         pluginHandler = new PluginHandler(receptionHandlerParameters.getPluginHandlerParameters().getName());
  56         initializeReception(receptionHandlerParameters.getReceptionHandlerConfigurationName());
  57     }
  58
  59     /**
  60      * Sub classes must implement this method to perform the specific initialization required to receive inputs, for
  61      * example setting up subscriptions.
  62      *
  63      * @param parameterGroupName the parameter group name
  64      * @throws PluginInitializationException if initialization of reception handler fails
  65      */
  66     protected abstract void initializeReception(String parameterGroupName) throws PluginInitializationException;
  67
  68     /**
  69      * Handle input that has been received. The given input shall be decoded using the {@link PolicyDecoder}s configured
  70      * for this reception handler and forwarded using the {@link PolicyForwarder}s configured for this reception
  71      * handler.
  72      *
  73      * @param policyInput the input that has been received
  74      * @throws PolicyDecodingException if an error occurs in decoding a policy from the received input
  75      */
  76     protected void inputReceived(final PolicyInput policyInput) throws PolicyDecodingException {
  77
  78         final Collection<Policy> policies = new ArrayList<>();
  79         for (final PolicyDecoder<PolicyInput, Policy> policyDecoder : getRelevantPolicyDecoders(policyInput)) {
  80             policies.addAll(policyDecoder.decode(policyInput));
  81         }
  82
  83         for (final PolicyForwarder policyForwarder : pluginHandler.getPolicyForwarders()) {
  84             try {
  85                 policyForwarder.forward(policies);
  86             } catch (final PolicyForwardingException policyForwardingException) {
  87                 LOGGER.error("Error when forwarding policies to " + policyForwarder, policyForwardingException);
  88             }
  89         }
  90     }
  91
  92     private Collection<PolicyDecoder<PolicyInput, Policy>> getRelevantPolicyDecoders(final PolicyInput policyInput)
  93             throws PolicyDecodingException {
  94         final Collection<PolicyDecoder<PolicyInput, Policy>> relevantPolicyDecoders = new ArrayList<>();
  95         for (final PolicyDecoder<PolicyInput, Policy> policyDecoder : pluginHandler.getPolicyDecoders()) {
  96             if (policyDecoder.canHandle(policyInput)) {
  97                 relevantPolicyDecoders.add(policyDecoder);
  98             }
  99         }
 100         if (relevantPolicyDecoders.isEmpty()) {
 101             throw new PolicyDecodingException("No decoder available matching requirements");
 102         }
 103         return relevantPolicyDecoders;
 104     }
 105
 106 }