org.graylog2.plugin.filters.MessageFilter Maven / Gradle / Ivy
/**
* This file is part of Graylog.
*
* Graylog 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.
*
* Graylog 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 Graylog. If not, see .
*/
package org.graylog2.plugin.filters;
import org.graylog2.plugin.Message;
public interface MessageFilter {
/**
* Process a Message
*
* @return true if this message should not further be handled (for example for blacklisting purposes)
*/
boolean filter(Message msg);
/**
* @return The name of this filter. Should not include whitespaces or special characters.
*/
String getName();
/**
* For determining the runtime order of the filter, specify a priority.
* Lower priority values are run earlier, if two filters have the same priority, their name will be compared to
* guarantee a repeatable order.
*
* @return the priority
*/
int getPriority();
}