org.graylog2.contentpacks.model.entities.NativeEntityDescriptor 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.1
/*
 * 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.graylog2.contentpacks.model.entities;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
import com.google.auto.value.AutoValue;
import org.graylog2.contentpacks.model.Identified;
import org.graylog2.contentpacks.model.ModelId;
import org.graylog2.contentpacks.model.ModelType;
import org.graylog2.contentpacks.model.Typed;

/**
 * The unique description of a native entity by ID and type.
 */
@AutoValue
@JsonDeserialize(builder = NativeEntityDescriptor.Builder.class)
public abstract class NativeEntityDescriptor implements Identified, Typed {
    public static final String FIELD_ENTITY_ID = "content_pack_entity_id";
    public static final String FIELD_ENTITY_FOUND_ON_SYSTEM = "found_on_system";
    public static final String FIELD_ENTITY_TITLE = "title";

    @JsonProperty(FIELD_ENTITY_ID)
    public abstract ModelId contentPackEntityId();

    @JsonProperty(FIELD_ENTITY_TITLE)
    public abstract String title();

    @JsonProperty(FIELD_ENTITY_FOUND_ON_SYSTEM)
    public abstract boolean foundOnSystem();

    public abstract Builder toBuilder();

    public static NativeEntityDescriptor create(ModelId contentPackEntityId, ModelId id, ModelType type, String title) {
        return builder()
                .contentPackEntityId(contentPackEntityId)
                .id(id)
                .title(title)
                .type(type)
                .build();
    }

    public static NativeEntityDescriptor create(ModelId contentPackEntityId, ModelId id, ModelType type, String title,
                                                boolean foundOnSystem) {
        return builder()
                .contentPackEntityId(contentPackEntityId)
                .id(id)
                .title(title)
                .type(type)
                .foundOnSystem(foundOnSystem)
                .build();
    }

    /**
     * Shortcut for {@link #create(String, String, ModelType, String, boolean)}
     */
    public static NativeEntityDescriptor create(String contentPackEntityId, String nativeId, ModelType type, String title,
                                                boolean foundOnSystem) {
        return create(ModelId.of(contentPackEntityId), ModelId.of(nativeId), type, title, foundOnSystem);
    }

    public static NativeEntityDescriptor create(String contentPackEntityId, String nativeId, ModelType type, String title) {
        return create(ModelId.of(contentPackEntityId), ModelId.of(nativeId), type, title, false);
    }

    public static NativeEntityDescriptor create(ModelId contentPackEntityId, String nativeId, ModelType type, String title,
                                                boolean foundOnSystem) {
        return create(contentPackEntityId, ModelId.of(nativeId), type, title, foundOnSystem);
    }

    public static NativeEntityDescriptor create(ModelId contentPackEntityId, String nativeId, ModelType type, String title) {
        return create(contentPackEntityId, ModelId.of(nativeId), type, title, false);
    }

    public static Builder builder() {
        return NativeEntityDescriptor.Builder.create();
    }

    @AutoValue.Builder
    public abstract static class Builder implements IdBuilder, TypeBuilder {
        @JsonCreator
        public static Builder create() {
            return new AutoValue_NativeEntityDescriptor.Builder().foundOnSystem(false);
        }

        @JsonProperty(FIELD_ENTITY_ID)
        abstract Builder contentPackEntityId(ModelId contentPackEntityId);

        @JsonProperty(FIELD_ENTITY_TITLE)
        abstract Builder title(String title);

        @JsonProperty(FIELD_ENTITY_FOUND_ON_SYSTEM)
        public abstract Builder foundOnSystem(boolean foundOnSystem);

        public abstract NativeEntityDescriptor build();
    }
}