IncludeInfo.java

/*
 * IncludeInfo.java
 * PROJECT: JDigiDoc
 * DESCRIPTION: Holds data about timestamp source. 
 * AUTHOR:  Veiko Sinivee, S|E|B IT Partner Estonia
 *==================================================
 * Copyright (C) AS Sertifitseerimiskeskus
 * 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.
 * GNU Lesser General Public Licence is available at
 * http://www.gnu.org/copyleft/lesser.html
 *==================================================
 */
package es.uji.security.crypto.openxades.digidoc;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.util.ArrayList;

import es.uji.security.crypto.openxades.digidoc.utils.ConvertUtils;

/**
 * Models the ETSI <Include> element Holds info about source of data used to calculate timestamp
 * hash. Such elements will be serialized as part of a timestamp element.
 * 
 * @author Veiko Sinivee
 * @version 1.0
 */
public class IncludeInfo
{
    /** elements URI atribute */
    private String m_uri;
    /** parent object - TimestampInfo ref */
    private TimestampInfo m_timestamp;

    /**
     * Creates new IncludeInfo and initializes everything to null
     */
    public IncludeInfo()
    {
        m_uri = null;
        m_timestamp = null;
    }

    /**
     * Creates new IncludeInfo
     * 
     * @param uri
     *            URI atribute value
     * @throws DigiDocException
     *             for validation errors
     */
    public IncludeInfo(String uri) throws DigiDocException
    {
        setUri(uri);
        m_timestamp = null;
    }

    /**
     * Accessor for TimestampInfo attribute
     * 
     * @return value of TimestampInfo attribute
     */
    public TimestampInfo getTimestampInfo()
    {
        return m_timestamp;
    }

    /**
     * Mutator for TimestampInfo attribute
     * 
     * @param uprops
     *            value of TimestampInfo attribute
     */
    public void setTimestampInfo(TimestampInfo t)
    {
        m_timestamp = t;
    }

    /**
     * Accessor for Uri attribute
     * 
     * @return value of Uri attribute
     */
    public String getUri()
    {
        return m_uri;
    }

    /**
     * Mutator for Uri attribute
     * 
     * @param str
     *            new value for Uri attribute
     * @throws DigiDocException
     *             for validation errors
     */
    public void setUri(String str) throws DigiDocException
    {
        DigiDocException ex = validateUri(str);
        if (ex != null)
            throw ex;
        m_uri = str;
    }

    /**
     * Helper method to validate Uri
     * 
     * @param str
     *            input data
     * @return exception or null for ok
     */
    private DigiDocException validateUri(String str)
    {
        DigiDocException ex = null;
        if (str == null)
            ex = new DigiDocException(DigiDocException.ERR_INCLUDE_URI,
                    "URI atribute cannot be empty", null);
        return ex;
    }

    /**
     * Helper method to validate the whole IncludeInfo object
     * 
     * @return a possibly empty list of DigiDocException objects
     */
    public ArrayList validate()
    {
        ArrayList errs = new ArrayList();
        DigiDocException ex = validateUri(m_uri);
        if (ex != null)
            errs.add(ex);
        return errs;
    }

    /**
     * Converts the IncludeInfo to XML form
     * 
     * @return XML representation of IncludeInfo
     */
    public byte[] toXML() throws DigiDocException
    {
        ByteArrayOutputStream bos = new ByteArrayOutputStream();
        try
        {
            bos.write(ConvertUtils.str2data("<Include URI=\""));
            bos.write(ConvertUtils.str2data(m_uri));
            bos.write(ConvertUtils.str2data("\"></Include>"));
        }
        catch (IOException ex)
        {
            DigiDocException.handleException(ex, DigiDocException.ERR_XML_CONVERT);
        }
        return bos.toByteArray();
    }

    /**
     * Returns the stringified form of CompleteCertificateRefs
     * 
     * @return CompleteCertificateRefs string representation
     */
    public String toString()
    {
        String str = null;
        try
        {
            str = new String(toXML());
        }
        catch (Exception ex)
        {
        }
        return str;
    }

}