eu.europa.esig.dss.asic.common.signature.AbstractASiCContentBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dss-asic-common Show documentation
DSS ASiC-common contains common classes between ASiC C/XAdES.
There is a newer version: 6.0.d4j.2
/**
 * DSS - Digital Signature Services
 * Copyright (C) 2015 European Commission, provided under the CEF programme
 * 
 * This file is part of the "DSS - Digital Signature Services" project.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package eu.europa.esig.dss.asic.common.signature;

import eu.europa.esig.dss.asic.common.ASiCContent;
import eu.europa.esig.dss.asic.common.ASiCUtils;
import eu.europa.esig.dss.asic.common.AbstractASiCContainerExtractor;
import eu.europa.esig.dss.enumerations.ASiCContainerType;
import eu.europa.esig.dss.exception.IllegalInputException;
import eu.europa.esig.dss.model.DSSDocument;
import eu.europa.esig.dss.spi.DSSUtils;
import eu.europa.esig.dss.utils.Utils;

import java.util.ArrayList;
import java.util.List;

/**
 * Abstract class used to build an instance of {@code ASiCContent}.
 * As input an ASiC Container can be used or documents to be signed
 *
 */
public abstract class AbstractASiCContentBuilder {

    /** The default name for a detached file if one is not defined */
    private static final String ZIP_ENTRY_DETACHED_FILE = "detached-file";

    /**
     * Default constructor
     */
    protected AbstractASiCContentBuilder() {
        // empty
    }

    /**
     * Builds the {@code ASiCContent} from the
     *
     * @param documents representing an ASiC Container or a list of documents to be signed
     * @param asicContainerType {@link ASiCContainerType} representing the target ASiC Container type
     * @return {@link ASiCContent}
     */
    public ASiCContent build(List documents, ASiCContainerType asicContainerType) {
        if (Utils.isCollectionNotEmpty(documents) && documents.size() == 1) {
            DSSDocument archiveDocument = documents.get(0);
            if (ASiCUtils.isZip(archiveDocument) && isAcceptableContainerFormat(archiveDocument)) {
                return fromZipArchive(archiveDocument, asicContainerType);
            }
        }
        return fromFiles(documents, asicContainerType);
    }

    /**
     * Method verifies whether the given {@code archiveDocument} has an acceptable to the format type
     *
     * @param archiveDocument {@link DSSDocument}
     * @return TRUE if the given document corresponds to the current format, FALSE otherwise
     */
    protected abstract boolean isAcceptableContainerFormat(DSSDocument archiveDocument);

    private ASiCContent fromZipArchive(DSSDocument archiveDoc, ASiCContainerType asicContainerType) {
        AbstractASiCContainerExtractor extractor = getContainerExtractor(archiveDoc);
        ASiCContent asicContent = extractor.extract();
        assertContainerTypeValid(asicContent, asicContainerType);

        return asicContent;
    }

    private ASiCContent fromFiles(List documents, ASiCContainerType asicContainerType) {
        assertDocumentNamesDefined(documents);

        ASiCContent asicContent = new ASiCContent();
        asicContent.setContainerType(asicContainerType);
        asicContent.setSignedDocuments(documents);

        return asicContent;
    }

    /**
     * Returns an instance of a corresponding container extractor class
     *
     * @param archiveDocument {@link DSSDocument} representing a container to be extracted
     * @return {@link AbstractASiCContainerExtractor}
     */
    protected abstract AbstractASiCContainerExtractor getContainerExtractor(DSSDocument archiveDocument);

    private void assertContainerTypeValid(ASiCContent result, ASiCContainerType asicContainerType) {
        if (ASiCUtils.filesContainSignatures(DSSUtils.getDocumentNames(result.getAllDocuments()))
                && Utils.isCollectionEmpty(result.getSignatureDocuments())) {
            throw new UnsupportedOperationException("Container type doesn't match! The same container type shall be chosen.");
        }
        if (asicContainerType != result.getContainerType()) {
            throw new IllegalInputException(String.format(
                    "The provided container of type '%s' does not correspond the expected format '%s'!",
                    result.getContainerType(), asicContainerType));
        }
    }

    /**
     * Checks if the document names are defined and adds them if needed
     *
     * @param documents a list of {@link DSSDocument}
     */
    private void assertDocumentNamesDefined(List documents) {
        List unnamedDocuments = getDocumentsWithoutNames(documents);
        if (unnamedDocuments.size() == 1) {
            DSSDocument dssDocument = unnamedDocuments.iterator().next();
            dssDocument.setName(ZIP_ENTRY_DETACHED_FILE);
        } else {
            for (int ii = 0; ii < unnamedDocuments.size(); ii++) {
                DSSDocument dssDocument = unnamedDocuments.get(ii);
                dssDocument.setName(ZIP_ENTRY_DETACHED_FILE + "-" + ii);
            }
        }
    }

    private List getDocumentsWithoutNames(List documents) {
        List result = new ArrayList<>();
        for (DSSDocument document : documents) {
            if (Utils.isStringBlank(document.getName())) {
                result.add(document);
            }
        }
        return result;
    }

}