no.difi.asic.AsicWriterFactory Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-asic Show documentation
Generic implementation of ASiC-E archives in accordance with ETSI 102 918 v1.3.1.
There is a newer version: 1.0.0
package no.difi.asic;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.Path;

/**
 * Creates AsicWriter instances according to the supplied parameters.
 *
 */
public class AsicWriterFactory {

    private static Logger logger = LoggerFactory.getLogger(AsicWriterFactory.class);

    /**
     * Creates an AsicWriterFactory, which utilises the default signature method, which is currently CAdES.
     *
     * @return instantiated AsicWriterFactory
     */
    public static AsicWriterFactory newFactory() {
        return newFactory(SignatureMethod.CAdES);
    }

    /**
     * Creates an AsicWriterFactory using the supplied signature method.
     *
     * @param signatureMethod the signature method to be used.
     * @return instantiated AsicWriterFactory
     * @see SignatureMethod
     */
    public static AsicWriterFactory newFactory(SignatureMethod signatureMethod) {
        return new AsicWriterFactory(signatureMethod);
    }

    private SignatureMethod signatureMethod;

    private AsicWriterFactory(SignatureMethod signatureMethod) {
        this.signatureMethod = signatureMethod;
    }

    /**
     * Factory method creating a new AsicWriter, which will create an ASiC archive in the supplied directory with the supplied file name
     * @param outputDir the directory in which the archive will be created.
     * @param filename the name of the archive.
     * @return an instance of AsicWriter
     * @throws IOException
     */
    public AsicWriter newContainer(File outputDir, String filename) throws IOException {
        return newContainer(new File(outputDir, filename));
    }

    /**
     * Creates a new AsicWriter, which will create an ASiC archive in the supplied file.
     * @param file the file reference to the archive.
     * @return an instance of AsicWriter
     * @throws IOException
     */
    public AsicWriter newContainer(File file) throws IOException {
        return newContainer(file.toPath());
    }

    /**
     * @see #newContainer(File)
     */
    public AsicWriter newContainer(Path path) throws IOException {
        // Conformance to ETSI TS 102 918, 6.2.1 1)
        if (!AsicUtils.PATTERN_EXTENSION_ASICE.matcher(path.toString()).matches())
            logger.warn("ASiC-E files should use \"asice\" as file extension.");

        return newContainer(Files.newOutputStream(path), true);
    }

    /**
     * Creates a new AsicWriter, which will write the container contents to the supplied output stream.
     * @param outputStream stream into which the archive will be written.
     * @return an instance of AsicWriter
     * @throws IOException
     */
    public AsicWriter newContainer(OutputStream outputStream) throws IOException {
        return newContainer(outputStream, false);
    }

    AsicWriter newContainer(OutputStream outputStream, boolean closeStreamOnClose) throws IOException {
        switch (signatureMethod) {
            case CAdES:
                return new CadesAsicWriter(signatureMethod, outputStream, closeStreamOnClose);
            case XAdES:
                return new XadesAsicWriter(signatureMethod, outputStream, closeStreamOnClose);
            default:
                throw new IllegalStateException(String.format("Not implemented: %s", signatureMethod));
        }
    }
}