eu.europa.esig.dss.validation.report.SimpleReport.java Source code

Introduction

Here is the source code for eu.europa.esig.dss.validation.report.SimpleReport.java

Source

/**
 * 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.validation.report;

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

import org.apache.commons.lang.StringUtils;
import org.w3c.dom.Document;
import org.w3c.dom.NamedNodeMap;
import org.w3c.dom.Node;

import eu.europa.esig.dss.XmlDom;
import eu.europa.esig.dss.validation.policy.SignatureType;
import eu.europa.esig.dss.validation.policy.rules.Indication;

/**
 * A SimpleReport holder to fetch properties from a XmlDom simpleReport.
 *
 */
public class SimpleReport extends XmlDom {

    public SimpleReport(final Document document) {

        super(document);
    }

    /**
     * This method returns the validation time.
     *
     * @return
     */
    public Date getValidationTime() {

        final Date validationTime = getTimeValue("/SimpleReport/ValidationTime/text()");
        return validationTime;
    }

    /**
     * This method returns the indication obtained after the validation of the signature.
     *
     * @param signatureId DSS unique identifier of the signature
     * @return
     */
    public String getIndication(final String signatureId) {

        final String indication = getValue("/SimpleReport/Signature[@Id='%s']/Indication/text()", signatureId);
        return indication;
    }

    /**
     * This method returns the sub-indication obtained after the validation of the signature.
     *
     * @param signatureId DSS unique identifier of the signature
     * @return
     */
    public String getSubIndication(final String signatureId) {

        final String subIndication = getValue("/SimpleReport/Signature[@Id='%s']/SubIndication/text()",
                signatureId);
        return subIndication;
    }

    /**
     * @param signatureId the signature id to test
     * @return true if the signature Indication element is equals to {@link Indication#VALID}
     */
    public boolean isSignatureValid(final String signatureId) {

        final String indicationValue = getIndication(signatureId);
        return Indication.VALID.equals(indicationValue);
    }

    /**
     * Returns the signature type: QES, AdES, AdESqc, NA
     *
     * @param signatureId
     * @return {@code SignatureType}
     */
    public SignatureType getSignatureLevel(final String signatureId) {

        final String signatureTypeString = getValue("/SimpleReport/Signature[@Id='%s']/SignatureLevel/text()",
                signatureId);
        SignatureType signatureType;
        try {
            signatureType = SignatureType.valueOf(signatureTypeString);
        } catch (IllegalArgumentException e) {
            signatureType = SignatureType.NA;
        }
        return signatureType;
    }

    /**
     * @return the {@code List} of signature id(s) contained in the simpleReport
     */
    public List<String> getSignatureIdList() {

        final List<String> signatureIdList = new ArrayList<String>();
        final List<XmlDom> signatures = getElements("/SimpleReport/Signature");
        for (final XmlDom signature : signatures) {
            signatureIdList.add(signature.getAttribute("Id"));
        }
        return signatureIdList;
    }

    /**
     * This method returns the first signature id.
     *
     * @return
     */
    public String getFirstSignatureId() {

        final List<String> signatureIdList = getSignatureIdList();
        if (signatureIdList.size() > 0) {
            return signatureIdList.get(0);
        }
        return null;
    }

    public List<Conclusion.BasicInfo> getInfo(final String signatureId) {

        final List<Conclusion.BasicInfo> infoList = getBasicInfo(signatureId, "Info");
        return infoList;
    }

    public List<Conclusion.BasicInfo> getErrors(final String signatureId) {

        final List<Conclusion.BasicInfo> errorList = getBasicInfo(signatureId, "Error");
        return errorList;
    }

    public List<Conclusion.BasicInfo> getWarnings(final String signatureId) {

        final List<Conclusion.BasicInfo> errorList = getBasicInfo(signatureId, "Warning");
        return errorList;
    }

    private List<Conclusion.BasicInfo> getBasicInfo(final String signatureId, final String basicInfoType) {

        final List<XmlDom> elementList = getElements("/SimpleReport/Signature[@Id='%s']/" + basicInfoType,
                signatureId);
        final List<Conclusion.BasicInfo> infoList = new ArrayList<Conclusion.BasicInfo>();
        for (final XmlDom infoElement : elementList) {

            Conclusion.BasicInfo basicInfo = new Conclusion.BasicInfo(basicInfoType);
            basicInfo.setValue(infoElement.getText());
            final NamedNodeMap attributes = infoElement.getAttributes();
            for (int index = 0; index < attributes.getLength(); index++) {

                final Node attribute = attributes.item(index);
                basicInfo.setAttribute(attribute.getNodeName(), attribute.getNodeValue());
            }
            infoList.add(basicInfo);
        }
        return infoList;
    }

    /**
     * This method returns the signature format (XAdES_BASELINE_B...)
     *
     * @param signatureId
     * @return
     */
    public String getSignatureFormat(final String signatureId) {
        String indication = StringUtils.EMPTY;
        XmlDom signature = getElement("/SimpleReport/Signature[@Id='%s']", signatureId);
        if (signature != null) {
            indication = signature.getAttribute("SignatureFormat");
        }
        return indication;
    }

}