001/**
002 * Copyright 2014 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     * @return a {@link FixityResult} containing the relevant data
033     * @throws RepositoryException
034     */
035    Collection<FixityResult> checkFixity(final String algorithm)
036        throws RepositoryException;
037
038    /**
039     * Get a raw input stream from the underlying store
040     * @return the content for this entry
041     * @throws RepositoryException
042     */
043    abstract InputStream getInputStream() throws RepositoryException;
044
045    /**
046     * Generate a human-readable identifier for the location of this entry
047     *
048     * @return human-readable identifier for the location of this entry
049     * @throws RepositoryException
050     */
051    abstract String getExternalIdentifier() throws RepositoryException;
052}