org.graylog.plugins.pipelineprocessor.functions.strings.StringUtilsFunction 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.strings;

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 java.util.Locale;

public abstract class StringUtilsFunction extends AbstractFunction {

    private static final String VALUE = "value";
    private static final String LOCALE = "locale";
    private final ParameterDescriptor valueParam;
    private final ParameterDescriptor localeParam;

    public StringUtilsFunction() {
        valueParam = ParameterDescriptor.string(VALUE).description("The input string").build();
        localeParam = ParameterDescriptor.string(LOCALE, Locale.class)
                .optional()
                .transform(Locale::forLanguageTag)
                .description("The locale to use, defaults to English")
                .build();
    }

    @Override
    public String evaluate(FunctionArgs args, EvaluationContext context) {
        final String value = valueParam.required(args, context);
        Locale locale = Locale.ENGLISH;
        if (isLocaleAware()) {
            locale = localeParam.optional(args, context).orElse(Locale.ENGLISH);
        }
        return apply(value, locale);
    }

    @Override
    public FunctionDescriptor descriptor() {
        ImmutableList.Builder params = ImmutableList.builder();
        params.add(valueParam);
        if (isLocaleAware()) {
            params.add(localeParam);
        }
        return FunctionDescriptor.builder()
                .name(getName())
                .returnType(String.class)
                .params(params.build())
                .description(description())
                .build();
    }

    protected abstract String getName();

    protected abstract String description();

    protected abstract boolean isLocaleAware();

    protected abstract String apply(String value, Locale locale);
}