org.graylog.plugins.pipelineprocessor.functions.messages.DropMessage Maven / Gradle / Ivy
/*
* Copyright (C) 2020 Graylog, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program 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
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* .
*/
package org.graylog.plugins.pipelineprocessor.functions.messages;
import com.google.common.collect.ImmutableList;
import org.graylog.plugins.pipelineprocessor.EvaluationContext;
import org.graylog.plugins.pipelineprocessor.ast.functions.AbstractFunction;
import org.graylog.plugins.pipelineprocessor.ast.functions.FunctionArgs;
import org.graylog.plugins.pipelineprocessor.ast.functions.FunctionDescriptor;
import org.graylog.plugins.pipelineprocessor.ast.functions.ParameterDescriptor;
import org.graylog2.plugin.Message;
import static org.graylog.plugins.pipelineprocessor.ast.functions.ParameterDescriptor.type;
public class DropMessage extends AbstractFunction {
public static final String NAME = "drop_message";
public static final String MESSAGE_ARG = "message";
private final ParameterDescriptor messageParam;
public DropMessage() {
messageParam = type(MESSAGE_ARG, Message.class).optional().description("The message to drop, defaults to '$message'").build();
}
@Override
public Void evaluate(FunctionArgs args, EvaluationContext context) {
final Message message = messageParam.optional(args, context).orElse(context.currentMessage());
message.setFilterOut(true);
return null;
}
@Override
public FunctionDescriptor descriptor() {
return FunctionDescriptor.builder()
.name(NAME)
.pure(true)
.returnType(Void.class)
.params(ImmutableList.of(
messageParam
))
.description("Discards a message from further processing")
.build();
}
}