org.digidoc4j.ddoc.SignedDataObjectProperties Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ddoc4j Show documentation

DDoc4J is Java Library for validating DDOC documents. It's not recommended to use it directly but rather through DigiDoc4J's API.

The newest version!

package org.digidoc4j.ddoc;

import java.io.Serializable;
import java.util.ArrayList;

/**
 * Models an XML-DSIG/ETSI SignedDataObjectProperties structure.
 * This structure is used to hold various properties of all
 * signed data objects referenced by one signature.
 * @author  Veiko Sinivee
 * @version 1.0
 */
public class SignedDataObjectProperties implements Serializable
{
    private static final long serialVersionUID = 1L;
    /** DataObjectFormat elements */
    private ArrayList m_dataObjectFormats;
    // other XAdES structure elements not supported

    /**
     * Default constructor for SignedDataObjectProperties
     */
    public SignedDataObjectProperties()
    {
        m_dataObjectFormats = null;
    }

    /**
     * return the count of DataObjectFormat objects
     * @return count of DataObjectFormat objects
     */
    public int countDataObjectFormats()
    {
        return ((m_dataObjectFormats == null) ? 0 : m_dataObjectFormats.size());
    }

    /**
     * Adds a new DataObjectFormat object
     * @param dof new object to be added
     */
    public void addDataObjectFormat(DataObjectFormat dof)
    {
        if(m_dataObjectFormats == null)
            m_dataObjectFormats = new ArrayList();
        m_dataObjectFormats.add(dof);
    }

    /**
     * Retrieves DataObjectFormat element with the desired index
     * @param idx DataObjectFormat index
     * @return DataObjectFormat element or null if not found
     */
    public DataObjectFormat getDataObjectFormat(int idx)
    {
        if(m_dataObjectFormats != null && idx < m_dataObjectFormats.size()) {
            return (DataObjectFormat)m_dataObjectFormats.get(idx);
        }
        return null; // not found
    }

    /**
     * Retrieves the last DataObjectFormat element
     * @return DataObjectFormat element or null if not found
     */
    public DataObjectFormat getLastDataObjectFormat()
    {
        if(m_dataObjectFormats != null && m_dataObjectFormats.size() > 0) {
            return (DataObjectFormat)m_dataObjectFormats.get(m_dataObjectFormats.size()-1);
        }
        return null; // not found
    }

    /**
     * Helper method to validate the whole
     * DataObjectFormat object
     * @return a possibly empty list of DigiDocException objects
     */
    public ArrayList validate()
    {
        ArrayList errs = new ArrayList();
        for(int i = 0; (m_dataObjectFormats != null) && (i < m_dataObjectFormats.size()); i++) {
            DataObjectFormat dof = (DataObjectFormat)m_dataObjectFormats.get(i);
            ArrayList errs2 = dof.validate();
            if(errs2 != null && errs2.size() > 0)
                errs.addAll(errs2);
        }
        return errs;
    }
}