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.api.utils;
017
018import java.io.InputStream;
019import java.util.Collection;
020
021/**
022 * A CacheEntry abstraction for the various possible types of entries
023 * @author fasseg
024 *
025 */
026public interface CacheEntry {
027
028    /**
029     * Check the fixity of a {@link CacheEntry}
030     * @param algorithm the given algorithm
031     * @return a {@link FixityResult} containing the relevant data
032     */
033    Collection<FixityResult> checkFixity(final String algorithm);
034
035    /**
036     * Get a raw input stream from the underlying store
037     * @return the content for this entry
038     */
039    abstract InputStream getInputStream();
040
041    /**
042     * Generate a human-readable identifier for the location of this entry
043     *
044     * @return human-readable identifier for the location of this entry
045     */
046    abstract String getExternalIdentifier();
047}