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.net.URI;
021import java.util.Set;
022
023/**
024 * @author bbpennel
025 * @since Feb 18, 2014
026 */
027public interface FixityResult {
028
029    /**
030     * The possible fixity states (which may be ORed together later)
031     */
032    enum FixityState {
033        SUCCESS, BAD_CHECKSUM, BAD_SIZE
034    }
035
036    /**
037     * Check if the fixity result matches the given checksum URI
038     *
039     * @param checksum the given checksum uri
040     * @return fixity result matches the given checksum URI
041     */
042    boolean matches(URI checksum);
043
044    /**
045     * Check if the fixity result matches the given size
046     *
047     * @param size the given size
048     * @return fixity result matches the given size
049     */
050    boolean matches(long size);
051
052    /**
053     * Does the fixity entry match the given size and checksum?
054     *
055     * @param size bitstream size in bytes
056     * @param checksum checksum URI
057     * @return true if both conditions matched
058     */
059    boolean matches(long size, URI checksum);
060
061    /**
062     * @param size the size
063     * @param checksum the checksum uri
064     * @return the status
065     */
066    Set<FixityState> getStatus(long size, URI checksum);
067
068    /**
069     * @return the computed size
070     */
071    long getComputedSize();
072
073    /**
074     * @return the computed checksum
075     */
076    URI getComputedChecksum();
077
078    /**
079     * @return the algorithm uses to compute the checksum
080     */
081    String getUsedAlgorithm();
082
083}