eu.europa.esig.dss.validation.status.RevocationFreshnessStatus Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dss-document Show documentation
DSS Document contains the code for the creation and validation of XAdES, CAdES, PAdES and ASiC signatures.
There is a newer version: 6.1
/**
 * 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.status;

import eu.europa.esig.dss.model.x509.Token;
import eu.europa.esig.dss.spi.DSSUtils;

import java.util.Date;
import java.util.HashMap;
import java.util.Map;

/**
 * Contains information about the performed revocation freshness check
 *
 */
public class RevocationFreshnessStatus extends TokenStatus {

    /**
     * Map between tokens concerned by the revocation freshness check and
     * the nextUpdate time of the corresponding revocation data
     */
    private final Map tokenRevocationNextUpdateMap = new HashMap<>();

    /**
     * Default constructor initializing an empty map
     */
    public RevocationFreshnessStatus() {
        // empty
    }

    /**
     * Adds concerned token and nextUpdate time of the revocation data
     *
     * @param token {@link Token}
     * @param revocationNextUpdate {@link String} message
     */
    public void addTokenAndRevocationNextUpdateTime(Token token, Date revocationNextUpdate) {
        tokenRevocationNextUpdateMap.put(token, revocationNextUpdate);
    }

    /**
     * Returns nextUpdate time of revocation data for the given token
     *
     * NOTE: returns Date only if the obtained revocation data is not fresh enough (otherwise returns null)
     *
     * @param token {@link Token} to get related revocation data's nextUpdate time
     * @return {@link Date}
     */
    public Date getTokenRevocationNextUpdateTime(Token token) {
        return tokenRevocationNextUpdateMap.get(token);
    }

    /**
     * Returns minimal time when revocation data should be updated for all concerned tokens
     *
     * NOTE: returns NULL if no suitable revocation data found or if the revocation data is fresh enough
     *
     * @return {@link Date}
     */
    public Date getMinimalNextUpdateTime() {
        Date minimalNextUpdate = null;
        for (Date nextUpdate : tokenRevocationNextUpdateMap.values()) {
            if (minimalNextUpdate == null || minimalNextUpdate.before(nextUpdate)) {
                minimalNextUpdate = nextUpdate;
            }
        }
        return minimalNextUpdate;
    }

    @Override
    public String getErrorString() {
        Date nextUpdateTime = getMinimalNextUpdateTime();
        return nextUpdateTime != null ?
                getMessage() + " NextUpdate time : " + DSSUtils.formatDateToRFC(nextUpdateTime) + " " + objectMapToString() :
                super.getErrorString();
    }

}