com.ca.apim.gateway.cagatewayconfig.tasks.gw7.GW7Builder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gateway-policy-plugin Show documentation
The gateway-policy-plugin enables developing gateway configuration.
The newest version!
/*
 * Copyright (c) 2018 CA. All rights reserved.
 * This software may be modified and distributed under the terms
 * of the MIT license.  See the LICENSE file for details.
 */

package com.ca.apim.gateway.cagatewayconfig.tasks.gw7;

import org.apache.commons.compress.archivers.tar.TarArchiveEntry;
import org.apache.commons.compress.archivers.tar.TarArchiveOutputStream;
import org.apache.commons.compress.compressors.gzip.GzipCompressorOutputStream;
import org.apache.commons.io.IOUtils;

import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.Set;
import java.util.function.Supplier;

/**
 * The packager build a Gateway Deployment Package. A GW7 file is to be able to package bundles, aars, bootstrap
 * scripts, solution kits, etc... all into a single file. This helps make distributing and deploying solutions simpler,
 * a single file to download, a single volume to mount.
 * 
 * Here is an example of a GW7 file structure:
 * 
 * opt/
 *   - docker/rc.d/
 *     - apply-environment.sh
 *   - SecureSpan/Gateway/
 *     - node/default/etc/bootstrap/bundle/
 *       - 1-my-bundle-1.0.00.req.bundle
 *       - custom-assertion.req.bundle
 *       - gateway-developer-example.req.bundle
 *       - helloworld.req.bundle
 *     - runtime/modules/
 *       - assertions/
 *         - Hello-World-Assertion-0.1.01.aar
 *       - lib/
 *         - custom-assertion-1.0.0.jar
 * 
 * The above package will add:
 * 
 * a bootstrap script apply-environment.sh
 * 4 bundle: 1-my-bundle-1.0.00.req.bundle, custom-assertion.req.bundle, gateway-developer-example.req.bundle, helloworld.req.bundle
 * a modular assertion: Hello-World-Assertion-0.1.01.aar
 * a custom assertion: custom-assertion-1.0.0.jar
 * 
 */
public class GW7Builder {
    public static final GW7Builder INSTANCE = new GW7Builder();

    public void buildPackage(OutputStream gw7FileOutputStream, Set packageFiles) {
        try (TarArchiveOutputStream taos = getTarOutputStream(gw7FileOutputStream)) {
            writeFiles(taos, packageFiles);
        } catch (IOException e) {
            throw new PackageBuildException("Error building GW7 Package: " + e.getMessage(), e);
        }
    }

    private TarArchiveOutputStream getTarOutputStream(OutputStream gw7FileOutputStream) throws IOException {
        TarArchiveOutputStream tarArchiveOutputStream = new TarArchiveOutputStream(new GzipCompressorOutputStream(gw7FileOutputStream));
        //This enables longer file paths within the tar
        tarArchiveOutputStream.setLongFileMode(TarArchiveOutputStream.LONGFILE_GNU);
        return tarArchiveOutputStream;
    }

    private void writeFiles(TarArchiveOutputStream taos, Set packageFiles) {
        for (PackageFile file : packageFiles) {
            try (InputStream inputStream = file.fileStreamSupplier.get()) {
                TarArchiveEntry tarEntry = new TarArchiveEntry(file.filePath);
                tarEntry.setSize(file.fileSize);
                if (file.executable) {
                    tarEntry.setMode(365);
                }
                taos.putArchiveEntry(tarEntry);
                IOUtils.copy(inputStream, taos);
                taos.closeArchiveEntry();
            } catch (IOException e) {
                throw new PackageBuildException("Error building GW7 Package. Error adding file: " + file.filePath + " Message: " + e.getMessage(), e);
            }
        }
    }

    public static class PackageFile {
        private final String filePath;
        private final long fileSize;
        private final Supplier fileStreamSupplier;
        private final boolean executable;

        public PackageFile(String filePath, long fileSize, Supplier fileStreamSupplier) {
            this(filePath, fileSize, fileStreamSupplier, false);
        }

        public PackageFile(String filePath, long fileSize, Supplier fileStreamSupplier, boolean executable) {
            this.filePath = filePath;
            this.fileSize = fileSize;
            this.fileStreamSupplier = fileStreamSupplier;
            this.executable = executable;
        }
    }
}