org.exist.xmldb.EXistBinaryResource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of exist-core Show documentation

eXist-db NoSQL Database Core

There is a newer version: 6.3.0

/*
 * eXist-db Open Source Native XML Database
 * Copyright (C) 2001 The eXist-db Authors
 *
 * [email protected]
 * http://www.exist-db.org
 *
 * 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 org.exist.xmldb;

import org.exist.storage.blob.BlobId;
import org.exist.util.crypto.digest.DigestType;
import org.exist.util.crypto.digest.MessageDigest;
import org.xmldb.api.base.XMLDBException;
import org.xmldb.api.modules.BinaryResource;

/**
 * Extensions for Binary Resources in eXist-db.
 */
public interface EXistBinaryResource extends BinaryResource {

    /**
     * Get the ID of the BLOB.
     *
     * @return the id of the BLOB.
     *
     * @throws XMLDBException if an error occurs retrieving the blobId.
     */
    BlobId getBlobId() throws XMLDBException;

    /**
     * Get the length of the binary content.
     *
     * @return the length of the binary content.
     *
     * @throws XMLDBException if an error occurs getting the content length.
     */
    long getContentLength() throws XMLDBException;

    /**
     * Get the digest of the BLOB content.
     *
     * @param digestType the message digest to use.
     *
     * @return the digest of the BLOB's content
     *
     * @throws XMLDBException if an error occurs getting the content digest.
     */
    MessageDigest getContentDigest(final DigestType digestType) throws XMLDBException;
}