001/*
002 * Licensed to DuraSpace under one or more contributor license agreements.
003 * See the NOTICE file distributed with this work for additional information
004 * regarding copyright ownership.
005 *
006 * DuraSpace licenses this file to you under the Apache License,
007 * Version 2.0 (the "License"); you may not use this file except in
008 * compliance with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.fcrepo.kernel.api.utils;
019
020import java.io.InputStream;
021import java.util.Collection;
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     */
035    Collection<FixityResult> checkFixity(final String algorithm);
036
037    /**
038     * Get a raw input stream from the underlying store
039     * @return the content for this entry
040     */
041    abstract InputStream getInputStream();
042
043    /**
044     * Generate a human-readable identifier for the location of this entry
045     *
046     * @return human-readable identifier for the location of this entry
047     */
048    abstract String getExternalIdentifier();
049}