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.services;
019
020import org.fcrepo.kernel.api.exception.UnsupportedAlgorithmException;
021import org.fcrepo.kernel.api.models.Binary;
022
023import java.net.URI;
024import java.util.Collection;
025
026/**
027 * Service which calculates and compares digests for binary objects
028 *
029 * @author peichman
030 */
031public interface FixityService {
032  /**
033   * Calculate the requested set of digests for the provided binary
034   * @param binary the binary resource to
035   * @param algorithms set of digest algorithms to calculate
036   * @return list of calculated digests
037   * @throws UnsupportedAlgorithmException if unsupported digest algorithms were provided
038   */
039  Collection<URI> getFixity(Binary binary, Collection<String> algorithms) throws UnsupportedAlgorithmException;
040
041  /**
042   * Digest this binary with the digest algorithms provided
043   * @param binary the binary resource to digest
044   * @param algorithms the digest algorithms to be used
045   * @return the checksums of this binary
046   * @throws org.fcrepo.kernel.api.exception.UnsupportedAlgorithmException if unsupported digest algorithm occurred
047   */
048  Collection<URI> checkFixity(Binary binary, Collection<String> algorithms) throws UnsupportedAlgorithmException;
049}