org.graylog.plugins.pipelineprocessor.ast.functions.ParameterDescriptor 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: 6.0.2
/**
 * 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.ast.functions;

import com.google.auto.value.AutoValue;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;

import org.graylog.plugins.pipelineprocessor.EvaluationContext;
import org.graylog.plugins.pipelineprocessor.ast.expressions.Expression;

import java.util.Optional;

import javax.annotation.Nullable;

@AutoValue
@JsonAutoDetect
public abstract class ParameterDescriptor {

    @JsonProperty
    public abstract Class type();

    @JsonProperty
    public abstract Class transformedType();

    @JsonProperty
    public abstract String name();

    @JsonProperty
    public abstract boolean optional();

    @JsonIgnore
    public abstract java.util.function.Function transform();

    @JsonProperty
    @Nullable
    public abstract String description();

    public static  Builder param() {
        return new AutoValue_ParameterDescriptor.Builder().optional(false);
    }

    public static Builder string(String name) {
        return string(name, String.class);
    }

    public static  Builder string(String name, Class transformedClass) {
        return ParameterDescriptor.param().type(String.class).transformedType(transformedClass).name(name);
    }

    public static Builder object(String name) {
        return object(name, Object.class);
    }

    public static  Builder object(String name, Class transformedClass) {
        return ParameterDescriptor.param().type(Object.class).transformedType(transformedClass).name(name);
    }

    public static Builder integer(String name) {
        return integer(name, Long.class);
    }

    public static  Builder integer(String name, Class transformedClass) {
        return ParameterDescriptor.param().type(Long.class).transformedType(transformedClass).name(name);
    }

    public static Builder floating(String name) {
        return floating(name, Double.class);
    }
    public static  Builder floating(String name, Class transformedClass) {
        return ParameterDescriptor.param().type(Double.class).transformedType(transformedClass).name(name);
    }

    public static Builder bool(String name) {
        return bool(name, Boolean.class);
    }

    public static  Builder bool(String name, Class transformedClass) {
        return ParameterDescriptor.param().type(Boolean.class).transformedType(transformedClass).name(name);
    }

    public static  Builder type(String name, Class typeClass) {
        return type(name, typeClass, typeClass);
    }

    public static  Builder type(String name, Class typeClass, Class transformedClass) {
        return ParameterDescriptor.param().type(typeClass).transformedType(transformedClass).name(name);
    }

    @Nullable
    public R required(FunctionArgs args, EvaluationContext context) {
        final Object precomputedValue = args.getPreComputedValue(name());
        if (precomputedValue != null) {
            return transformedType().cast(precomputedValue);
        }
        final Expression valueExpr = args.expression(name());
        if (valueExpr == null) {
            return null;
        }
        final Object value = valueExpr.evaluateUnsafe(context);
        return transformedType().cast(transform().apply(type().cast(value)));
    }

    public Optional optional(FunctionArgs args, EvaluationContext context) {
        return Optional.ofNullable(required(args, context));
    }

    @AutoValue.Builder
    public static abstract class Builder {
        public abstract Builder type(Class type);
        public abstract Builder transformedType(Class type);
        public abstract Builder name(String name);
        public abstract Builder optional(boolean optional);

        public Builder optional() {
            return optional(true);
        }

        public abstract Builder description(String description);

        abstract ParameterDescriptor autoBuild();
        public ParameterDescriptor build() {
            try {
                transform();
            } catch (IllegalStateException ignored) {
                // unfortunately there's no "hasTransform" method in autovalue
                //noinspection unchecked
                transform((java.util.function.Function) java.util.function.Function.identity());
            }
            return autoBuild();
        }

        public abstract Builder transform(@Nullable java.util.function.Function transform);
        @Nullable
        public abstract java.util.function.Function transform();

    }
}