StgCmtService.java

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is part of dcm4che, an implementation of DICOM(TM) in
 * Java(TM), hosted at https://github.com/gunterze/dcm4che.
 *
 * The Initial Developer of the Original Code is
 * Agfa Healthcare.
 * Portions created by the Initial Developer are Copyright (C) 2011-2013
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 * See @authors listed below
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

package org.dcm4chee.archive.stgcmt.scp;

import java.io.IOException;
import java.util.List;

import org.dcm4che3.data.Attributes;
import org.dcm4che3.net.TransferCapability.Role;
import org.dcm4che3.net.service.DicomServiceException;
import org.dcm4chee.archive.conf.ArchiveAEExtension;
import org.dcm4chee.archive.dto.ArchiveInstanceLocator;

/**
 * @author Gunter Zeilinger <gunterze@gmail.com>
 *
 */
public interface StgCmtService {
    
    static enum N_ACTION_REQ_STATE { INVALID_REQ, SEND_REQ_FAILED, SEND_REQ_OK }

    Attributes calculateResult(Attributes actionInfo) throws IOException;

    void scheduleNEventReport(String localAET, String remoteAET,
            Attributes eventInfo, int retries, long delay);

    void sendNEventReport(String localAET, String remoteAET,
            Attributes eventInfo, int retries);

    /**
     * Sends a Storage-Commitment N-Action request to the given remote AE.
     * 
     * @param localAET Calling AE for the N-Action request
     * @param remoteAET Receiving AE for the N-Action request
     * @param insts Instances for which a Storage-Commitment is requested
     * @param transactionUID UID which allows to later match a received N-Event report
     * with the request.
     * @return State defining if sending of the request has been successful. 
     * IMPORTANT: The state does NOT indicate anything about the response of the N-Action request, 
     * it just indicates if the request was sent successfully to the remote AE.
     */
    N_ACTION_REQ_STATE sendNActionRequest(String localAET, String remoteAET,
            List<ArchiveInstanceLocator> insts, String transactionUID);

    void coerceAttributes(Attributes attrs, String remoteAET,
            ArchiveAEExtension arcAE, Role role) throws DicomServiceException;

    void notify(CommitEvent commitEvent);
}