org.graylog.plugins.pipelineprocessor.functions.lookup.Lookup Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of graylog2-server Show documentation
Graylog
There is a newer version: 5.2.7
/**
 * 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.graylog.plugins.pipelineprocessor.functions.lookup;

import com.google.inject.Inject;
import com.google.inject.TypeLiteral;
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.lookup.LookupTableService;
import org.graylog2.plugin.lookup.LookupResult;

import java.util.Collections;
import java.util.Map;

import static org.graylog.plugins.pipelineprocessor.ast.functions.ParameterDescriptor.object;
import static org.graylog.plugins.pipelineprocessor.ast.functions.ParameterDescriptor.string;
import static org.graylog2.plugin.lookup.LookupResult.SINGLE_VALUE_KEY;

public class Lookup extends AbstractFunction> {

    public static final String NAME = "lookup";

    private final ParameterDescriptor lookupTableParam;
    private final ParameterDescriptor keyParam;
    private final ParameterDescriptor defaultParam;

    @Inject
    public Lookup(LookupTableService lookupTableService) {
        lookupTableParam = string("lookup_table", LookupTableService.Function.class)
                .description("The existing lookup table to use to lookup the given key")
                .transform(tableName -> lookupTableService.newBuilder().lookupTable(tableName).build())
                .build();
        keyParam = object("key")
                .description("The key to lookup in the table")
                .build();
        defaultParam = object("default")
                .description("The default multi value that should be used if there is no lookup result")
                .optional()
                .build();
    }

    @Override
    public Map evaluate(FunctionArgs args, EvaluationContext context) {
        Object key = keyParam.required(args, context);
        if (key == null) {
            return Collections.singletonMap(SINGLE_VALUE_KEY, defaultParam.optional(args, context).orElse(null));
        }
        LookupTableService.Function table = lookupTableParam.required(args, context);
        if (table == null) {
            return Collections.singletonMap(SINGLE_VALUE_KEY, defaultParam.optional(args, context).orElse(null));
        }
        LookupResult result = table.lookup(key);
        if (result == null || result.isEmpty()) {
            return Collections.singletonMap(SINGLE_VALUE_KEY, defaultParam.optional(args, context).orElse(null));
        }
        return result.multiValue();
    }

    @Override
    public FunctionDescriptor> descriptor() {
        //noinspection unchecked
        return FunctionDescriptor.>builder()
                .name(NAME)
                .description("Looks up a multi value in the named lookup table.")
                .params(lookupTableParam, keyParam, defaultParam)
                .returnType((Class>) new TypeLiteral>() {}.getRawType())
                .build();
    }
}