aboutsummaryrefslogtreecommitdiffstats
path: root/sdnr/wt/helpserver/provider/src/main/java/org/onap/ccsdk/features/sdnr/wt/helpserver/data/ExtactBundleResource.java
blob: ca3a4004348daa000ae967b819672b01d85d00df (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
104
105
106
107
108
109
110
111
112
113
114
/*
 * ============LICENSE_START========================================================================
 * ONAP : ccsdk feature sdnr wt
 * =================================================================================================
 * Copyright (C) 2019 highstreet technologies GmbH 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.ccsdk.features.sdnr.wt.helpserver.data;

import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Enumeration;
import org.osgi.framework.Bundle;

/**
 * Extract subtree with resources from Opendaylight/Karaf/OSGi bundle into Karaf directory<br>
 *
 * Reference: Eclipsezone @see
 * <a href="https://www.eclipsezone.com/eclipse/forums/t101557.html">https://www.eclipszone.com</a> <br>
 * <br>
 * Example for resource and directory path from karaf log. write resource: help/FAQ/0.4.0/README.md Create directories
 * for: data/cache/com.highstreet.technologies.help/help/FAQ/0.4.0/README.md Open the file:
 * data/cache/com.highstreet.technologies.help/help/FAQ/0.4.0/README.md Problem: Binary, JPG files => do not use buffer
 * related functions
 *
 * Hint: Verify with file manager the content of the bundle.jar file to see the location of the resources. There is no
 * need to mark them via the classpath.
 */

public class ExtactBundleResource {

    /**
     * Extract resources from Karaf/OSGi bundle into karaf directory structure.
     *
     * @param bundle Karaf/OSGi bundle with resources
     * @param filePrefix prefix in karaf file system for destination e.g. "data/cache/com.highstreet.technologies."
     * @param ressoureRoot root name of ressources, with leading "/". e.g. "/help"
     * @throws IOException In case of problems.
     */
    public static void copyBundleResoucesRecursively(Bundle bundle, String filePrefix, String ressoureRoot)
            throws IOException {
        copyResourceTreeRecurse(bundle, filePrefix, bundle.getEntryPaths(ressoureRoot));
    }

    /**
     * Delete a file or a directory and its children.
     *
     * @param file The directory to delete.
     * @throws IOException Exception when problem occurs during deleting the directory.
     */
    public static void deleteRecursively(File file) throws IOException {

        if (file.isDirectory()) {
            for (File childFile : file.listFiles()) {
                deleteRecursively(childFile);
            }
        }
        if (file.exists()) {
            if (!file.delete()) {
                throw new IOException("No file " + file.getName());
            }
        }
    }

    // ------------- Private functions

    /**
     * Recurse function to steps through the resource element tree
     *
     * @param b Bundle index for bundle with resourcs
     * @param filePrefix
     * @param resource
     * @throws IOException
     */
    private static void copyResourceTreeRecurse(Bundle b, String filePrefix, Enumeration<String> resource)
            throws IOException {
        while (resource.hasMoreElements()) {
            String name = resource.nextElement();
            Enumeration<String> list = b.getEntryPaths(name);
            if (list != null) {
                copyResourceTreeRecurse(b, filePrefix, list);
            } else {
                // Read
                File targetFile = new File(filePrefix + name);
                targetFile.getParentFile().mkdirs();

                try (InputStream in = b.getEntry(name).openStream();
                        OutputStream outStream = new FileOutputStream(targetFile);) {

                    int theInt;
                    while ((theInt = in.read()) >= 0) {
                        outStream.write(theInt);
                    }
                    in.close();
                    outStream.flush();
                    outStream.close();
                }
            }
        }
    }
}