aboutsummaryrefslogtreecommitdiffstats
path: root/runtime/src/main/java/org/onap/policy/clamp/clds/util/ResourceFileUtils.java
blob: d6184c6565ac9c5dc952363515bd358d23f61cdb (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
/*-
 * ============LICENSE_START=======================================================
 * ONAP POLICY-CLAMP
 * ================================================================================
 * Copyright (C) 2017, 2021 AT&T Intellectual Property. All rights
 *                             reserved.
 * ================================================================================
 * 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.
 * ============LICENSE_END============================================
 * ===================================================================
 *
 */

package org.onap.policy.clamp.clds.util;

import java.io.IOException;
import java.io.InputStream;
import java.util.Scanner;

/**
 * Utility methods supporting resources accesses.
 */
public final class ResourceFileUtils {

    /**
     * getResourceAsStram supports the "file:" prefix as they use URL.
     * So here we want to eliminate classpath: prefix, so that this class can get
     * files from jar resource or file system.
     */

    private static final String CLASSPATH_PREFIX = "classpath:";

    /**
     * Private constructor to avoid creating instances of util class.
     */
    private ResourceFileUtils() {
    }

    /**
     * Method to access a file from the jar resource folder or file system.
     * Give the prefix "classpath:" so that it accesses the jar resource folder (default case)
     * or the prefix "file:" so that it accesses the file system.
     *
     * @param fileName The path of the resource (no prefix it will be a classpath access,
     *                 "classpath:/myfilename" or "file:/myfilename")
     * @return The file as inputStream
     */
    public static InputStream getResourceAsStream(String fileName) {
        InputStream is = Thread.currentThread().getContextClassLoader()
                .getResourceAsStream(fileName.replaceFirst("^" + CLASSPATH_PREFIX, ""));
        if (is == null) {
            throw new IllegalArgumentException("Unable to find resource: " + fileName);
        }
        return is;
    }

    /**
     * Method to access a resource file as a string.
     * Give the prefix "classpath:" so that it accesses the jar resource folder (default case)
     * or the prefix "file:" so that it accesses the file system.
     *
     * @param fileName The path of the resource (no prefix it will be a classpath access,
     *                 "classpath:/myfilename" or "file:/myfilename")
     * @return The file as String
     * @throws IOException In case of failure to find the file.
     */
    public static String getResourceAsString(String fileName) throws IOException {
        try (InputStream is = getResourceAsStream(fileName)) {
            return streamToString(is);
        }
    }

    private static String streamToString(InputStream inputStream) {
        try (Scanner scanner = new Scanner(inputStream)) {
            Scanner delimitedScanner = scanner.useDelimiter("\\A");
            return delimitedScanner.hasNext() ? delimitedScanner.next() : "";
        }
    }
}