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 java.io.InputStream;
021import java.net.URI;
022import java.util.Collection;
023
024import org.fcrepo.kernel.api.Transaction;
025import org.fcrepo.kernel.api.identifiers.FedoraId;
026import org.fcrepo.kernel.api.models.ExternalContent;
027
028/**
029 * Interface for service to replace existing binaries
030 *
031 * @author mohideen
032 */
033public interface ReplaceBinariesService {
034
035    /**
036     * Replace an existing binary.
037     *
038     * @param tx The transaction for the request.
039     * @param userPrincipal the user performing the service
040     * @param fedoraId The internal identifier of the parent.
041     * @param filename The filename of the binary.
042     * @param contentType The content-type header or null if none.
043     * @param digests The binary digest or null if none.
044     * @param size The binary size.
045     * @param contentBody The request body or null if none.
046     * @param externalContent The external content handler or null if none.
047     */
048    void perform(Transaction tx,
049                 String userPrincipal,
050                 FedoraId fedoraId,
051                 String filename,
052                 String contentType,
053                 Collection<URI> digests,
054                 InputStream contentBody,
055                 long size,
056                 ExternalContent externalContent);
057}