se.skltp.mb.svc.services.MessageService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mb-composite-svc Show documentation
There is a newer version: 1.0.0-RC9
/**
 * Copyright (C) 2013 Inera AB (http://www.inera.se)
 *
 * This file is part of Inera MessageService (http://code.google.com/p/inera-message).
 *
 * Inera MessageService is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Inera MessageService is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package se.skltp.mb.svc.services;

import java.util.Collection;
import java.util.List;

import se.skltp.mb.svc.exception.UnreadDeleteException;
import se.skltp.mb.types.StatusReport;
import se.skltp.mb.types.entity.MessageMeta;

public interface MessageService {

    /**
     * Get messages for delivery to the target system.
     * 
     * Will mark the messages as delivered.
     * 

     * Will load the message bodies for all message metas.
     *
     *
     * @param targetSystem
     * @param ids        to get
     * @return list of messages with the given ids belonging to targetSystem
     *         (asking for ids not belonging to the targetSystem will be silently ignored)
     */
    List getMessages(String targetSystem, Collection ids);

    /**
     * List messages available for the given target system.
     *
     * @param targetSystem
     * @return list of messages
     */
    List listMessages(String targetSystem);

    /**
     * Fetch the meta-data for the given list of messages and targetSystem
     *
     * @param targetSystem
     * @return list of messages
     */
    List listMessages(String targetSystem, Collection ids);

    /**
     * SaveOrPersist a message.
     *
     *
     * @param message to persist
     * @return id of message
     */
    void saveMessage(MessageMeta message);

    /**
     * Create a message with the given arguments
     *
     * @param sourceSystem hsa-id of source system
     * @param targetSystem hsa-id of target system
     * @param targetOrganization hsa-id of target org
     * @param serviceContract of message
     * @param messageBody message body
     * @param correlationId  mule correlation id for the mule-message that delivered this message
     * @return created message, with arrival time set to TimeService.now() and status {@link se.skltp.mb.types.entity.MessageStatus#RECEIVED}
     */
    MessageMeta create(String sourceSystem, String targetSystem, String targetOrganization, String serviceContract, String messageBody, String correlationId);

    /**
     * Delete all identified messages, returning how many were actually deleted.
     *
     * @param targetSystem all messages must have this targetSystem
     * @param now current time (to determine delivery time for statistic purposes)
     * @param messages to delete
     * @throws UnreadDeleteException if any messages to be deleted haven't been read yet
     */
    void deleteMessages(String targetSystem, long now, List messages) throws UnreadDeleteException;


    /**
     * Get statistics for the current state of the target systems.
     * 
     * A target system which has no messages waiting to be delivered is not shown.
     *
     * @return an ordered list of entries for each (targetSyst, targetOrg, serviceContract) which has messages waiting to be delivered
     */
    public List getStatusReports();
}