aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/forwarding-plugins/src/main/java/org/onap/policy/distribution/forwarding/file/FilePolicyForwarder.java
blob: fde1a6fa29f521b17d668da95fa4e47ea5c7b426 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
/*-
 * ============LICENSE_START=======================================================
 *  Copyright (C) 2019 Intel Crop. All rights reserved.
 *  Modifications Copyright (C) 2020-2021 AT&T Intellectual Property. All rights reserved.
 *  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.file;

import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Files;
import java.nio.file.InvalidPathException;
import java.nio.file.Paths;
import java.util.Collection;
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.ToscaPolicy;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This class provides an implementation of {@link PolicyForwarder} interface for forwarding the given policies to a
 * file directory.
 */
public class FilePolicyForwarder implements PolicyForwarder {

    private static final Logger LOGGER = LoggerFactory.getLogger(FilePolicyForwarder.class);
    private FilePolicyForwarderParameterGroup fileForwarderParameters;

    /**
     * {@inheritDoc}.
     */
    @Override
    public void configure(final String parameterGroupName) {
        fileForwarderParameters = ParameterService.get(parameterGroupName);
        try {
            final var path = Paths.get(fileForwarderParameters.getPath());
            if (!path.toFile().exists()) {
                Files.createDirectories(path);
            }
        } catch (final InvalidPathException | IOException e) {
            LOGGER.error("Configuring FilePolicyForwarder failed!", e);
        }
    }

    /**
     * {@inheritDoc}.
     */
    @Override
    public void forward(final Collection<ToscaEntity> policies) throws PolicyForwardingException {
        for (final ToscaEntity policy : policies) {
            if (policy instanceof ToscaPolicy) {
                forwardPolicy((ToscaPolicy) policy);
            } else {
                final String message = "Cannot forward policy " + policy + ". Unsupported policy type "
                        + policy.getClass().getSimpleName();
                LOGGER.error(message);
                throw new PolicyForwardingException(message);
            }
        }
    }

    /**
     * Method to forward a given policy to be logged into a file.
     *
     * @param pol the policy
     * @throws PolicyForwardingException if any exception occurs while forwarding policy
     */
    private void forwardPolicy(final ToscaPolicy pol) throws PolicyForwardingException {
        final String name = pol.getName();
        final var path = Paths.get(fileForwarderParameters.getPath(), name);
        try (var writer = Files.newBufferedWriter(path, StandardCharsets.UTF_8)) {
            writer.write("policyName: " + name);
            if (fileForwarderParameters.isVerbose()) {
                writer.newLine();
                writer.write("policy: " + pol);
            }
            LOGGER.debug("Successfully forwarded the policy to store into file {}.", path);
        } catch (final InvalidPathException | IOException exp) {
            final String message = "Error sending policy to file under path:" + fileForwarderParameters.getPath();
            throw new PolicyForwardingException(message, exp);
        }
    }
}