001/*
002 * #%L
003 * Netarchivesuite - common
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.common.utils;
025
026/**
027 * This class encapsulates reacting to a serious error or warning message.
028 */
029public abstract class Notifications {
030
031    /**
032     * Notify about an event. This is the same as calling {@link #notify(String, NotificationType, Throwable)} with null
033     * as the second parameter.
034     *
035     * @param message The error message to notify about.
036     */
037    public void notify(String message, NotificationType eventType) {
038        notify(message, eventType, null);
039    }
040
041    /**
042     * Notifies about an event including an exception.
043     *
044     * @param message The message to notify about.
045     * @param eventType The type of event
046     * @param e An exception related to the event, if not the event itself May be null for no exception.
047     */
048    public abstract void notify(String message, NotificationType eventType, Throwable e);
049
050}