001/**
002 * Copyright 2015 DuraSpace, Inc.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *     http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.fcrepo.kernel.utils;
017
018import java.io.InputStream;
019import java.util.Collection;
020
021import javax.jcr.RepositoryException;
022
023/**
024 * A CacheEntry abstraction for the various possible types of entries
025 * @author fasseg
026 *
027 */
028public interface CacheEntry {
029
030    /**
031     * Check the fixity of a {@link CacheEntry}
032     * @param algorithm the given algorithm
033     * @return a {@link FixityResult} containing the relevant data
034     * @throws RepositoryException if repository exception occurred
035     */
036    Collection<FixityResult> checkFixity(final String algorithm)
037        throws RepositoryException;
038
039    /**
040     * Get a raw input stream from the underlying store
041     * @return the content for this entry
042     * @throws RepositoryException if repository exception occurred
043     */
044    abstract InputStream getInputStream() throws RepositoryException;
045
046    /**
047     * Generate a human-readable identifier for the location of this entry
048     *
049     * @return human-readable identifier for the location of this entry
050     * @throws RepositoryException if repository exception occurred
051     */
052    abstract String getExternalIdentifier() throws RepositoryException;
053}