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