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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  *  Copyright (C) 2018 Ericsson. All rights reserved.
   4  *  Copyright (C) 2019 Nordix Foundation.
   5  *  Modifications Copyright (C) 2020 AT&T Inc.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  *
  19  * SPDX-License-Identifier: Apache-2.0
  20  * ============LICENSE_END=========================================================
  21  */
  22
  23 package org.onap.policy.distribution.reception.decoding.policy.file;
  24
  25 import java.io.IOException;
  26 import java.util.ArrayList;
  27 import java.util.Collection;
  28 import java.util.Enumeration;
  29 import java.util.zip.ZipEntry;
  30 import java.util.zip.ZipFile;
  31 import org.onap.policy.common.parameters.ParameterService;
  32 import org.onap.policy.common.utils.coder.CoderException;
  33 import org.onap.policy.common.utils.coder.StandardCoder;
  34 import org.onap.policy.distribution.model.Csar;
  35 import org.onap.policy.distribution.model.PolicyInput;
  36 import org.onap.policy.distribution.reception.decoding.PolicyDecoder;
  37 import org.onap.policy.distribution.reception.decoding.PolicyDecodingException;
  38 import org.onap.policy.models.tosca.authorative.concepts.ToscaEntity;
  39 import org.onap.policy.models.tosca.authorative.concepts.ToscaServiceTemplate;
  40
  41 /**
  42  * This class extracts policy files from a CSAR file.
  43  *
  44  * @author Ram Krishna Verma (ram.krishna.verma@ericsson.com)
  45  */
  46 public class PolicyDecoderFileInCsarToPolicy implements PolicyDecoder<Csar, ToscaEntity> {
  47
  48     private PolicyDecoderFileInCsarToPolicyParameterGroup decoderParameters;
  49     private StandardCoder coder;
  50
  51     /**
  52      * {@inheritDoc}.
  53      */
  54     @Override
  55     public void configure(final String parameterGroupName) {
  56         decoderParameters = ParameterService.get(parameterGroupName);
  57         coder = new StandardCoder();
  58     }
  59
  60     /**
  61      * {@inheritDoc}.
  62      */
  63     @Override
  64     public boolean canHandle(final PolicyInput policyInput) {
  65         return policyInput.getClass().isAssignableFrom(Csar.class);
  66     }
  67
  68     /**
  69      * {@inheritDoc}.
  70      */
  71     @Override
  72     public Collection<ToscaEntity> decode(final Csar csar) throws PolicyDecodingException {
  73         final Collection<ToscaEntity> policyList = new ArrayList<>();
  74
  75         try (ZipFile zipFile = new ZipFile(csar.getCsarPath())) {
  76             final Enumeration<? extends ZipEntry> entries = zipFile.entries();
  77             while (entries.hasMoreElements()) {
  78                 final ZipEntry entry = entries.nextElement();
  79                 if (entry.getName().contains(decoderParameters.getPolicyTypeFileName())
  80                         || entry.getName().contains(decoderParameters.getPolicyFileName())) {
  81                     final ToscaServiceTemplate policy =
  82                             coder.decode(zipFile.getInputStream(entry), ToscaServiceTemplate.class);
  83                     policyList.add(policy);
  84                 }
  85             }
  86         } catch (final IOException | CoderException exp) {
  87             throw new PolicyDecodingException("Failed decoding the policy", exp);
  88         }
  89
  90         return policyList;
  91     }
  92 }