ReferenceValueException.java

/*
 * XAdES4j - A Java library for generation and verification of XAdES signatures.
 * Copyright (C) 2010 Luis Goncalves.
 *
 * XAdES4j 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 3 of the License, or any later version.
 *
 * XAdES4j 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 XAdES4j. If not, see <http://www.gnu.org/licenses/>.
 */
package xades4j.verification;

import org.apache.xml.security.signature.Reference;
import org.apache.xml.security.signature.XMLSignature;

/**
 * Thrown during signature verification when the core verification fails due to
 * reference validation.
 * @author Luís
 */
public class ReferenceValueException extends CoreVerificationException
{
    private final Reference reference;

    public ReferenceValueException(XMLSignature sig, Reference reference)
    {
        super(sig);
        this.reference = reference;
    }

    /**
     * Gets the reference that caused the validation error. If multiple references
     * are invalid, this is the first of them, in order of appearence.
     * @return the reference.
     */
    public Reference getReference()
    {
        return reference;
    }

    @Override
    public String getMessage()
    {
        return String.format("Reference '%s' cannot be validated", this.reference.getURI());
    }


}