001/* 002 * #%L 003 * Netarchivesuite - archive 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.archive.distribute; 025 026import dk.netarkivet.common.distribute.ChannelID; 027import dk.netarkivet.common.distribute.NetarkivetMessage; 028import dk.netarkivet.common.exceptions.ArgumentNotValid; 029 030/** 031 * Common base class for messages exchanged between an archive server and an archive client (or within an archive). 032 * 033 * @see NetarkivetMessage 034 */ 035@SuppressWarnings({"serial"}) 036public abstract class ArchiveMessage extends NetarkivetMessage { 037 /** 038 * Creates a new ArchiveMessage. 039 * 040 * @param to the initial receiver of the message 041 * @param replyTo the initial sender of the message 042 * @throws ArgumentNotValid if to==replyTo or there is a null parameter. 043 */ 044 protected ArchiveMessage(ChannelID to, ChannelID replyTo) throws ArgumentNotValid { 045 super(to, replyTo); 046 } 047 048 /** 049 * Should be implemented as a part of the visitor pattern. e.g.: public void accept(ArchiveMessageVisitor v) { 050 * v.visit(this); } 051 * 052 * @param v A message visitor 053 * @see ArchiveMessageVisitor 054 */ 055 public abstract void accept(ArchiveMessageVisitor v); 056}