001/*
002 * #%L
003 * Netarchivesuite - monitor
004 * %%
005 * Copyright (C) 2005 - 2014 The Royal Danish Library, the Danish State and University Library,
006 *             the National Library of France and the Austrian National Library.
007 * %%
008 * This program is free software: you can redistribute it and/or modify
009 * it under the terms of the GNU Lesser General Public License as
010 * published by the Free Software Foundation, either version 2.1 of the
011 * License, or (at your option) any later version.
012 * 
013 * This program is distributed in the hope that it will be useful,
014 * but WITHOUT ANY WARRANTY; without even the implied warranty of
015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
016 * GNU General Lesser Public License for more details.
017 * 
018 * You should have received a copy of the GNU General Lesser Public
019 * License along with this program.  If not, see
020 * <http://www.gnu.org/licenses/lgpl-2.1.html>.
021 * #L%
022 */
023
024package dk.netarkivet.monitor.distribute;
025
026import java.io.Serializable;
027
028import dk.netarkivet.common.distribute.ChannelID;
029import dk.netarkivet.common.distribute.NetarkivetMessage;
030import dk.netarkivet.common.exceptions.ArgumentNotValid;
031
032/**
033 * Common base class for messages exchanged between an archive server and an archive client (or within an archive).
034 *
035 * @see NetarkivetMessage
036 */
037@SuppressWarnings({"serial"})
038public abstract class MonitorMessage extends NetarkivetMessage implements Serializable {
039    /**
040     * Creates a new MonitorMessage.
041     *
042     * @param to the initial receiver of the message
043     * @param replyTo the initial sender of the message
044     * @throws ArgumentNotValid if to==replyTo or there is a null parameter.
045     */
046    protected MonitorMessage(ChannelID to, ChannelID replyTo) {
047        super(to, replyTo);
048    }
049
050    /**
051     * Should be implemented as a part of the visitor pattern. e.g.: public void accept(MonitorMessageVisitor v) {
052     * v.visit(this); }
053     *
054     * @param v A message visitor
055     * @see MonitorMessageVisitor
056     */
057    public abstract void accept(MonitorMessageVisitor v);
058}