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 public static enum FixityState { 033 SUCCESS, BAD_CHECKSUM, BAD_SIZE 034 } 035 036 /** 037 * Get the identifier for the entry's store 038 * @return String 039 */ 040 String getStoreIdentifier(); 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}