org.graylog2.contentpacks.model.entities.ScopedContentPackEntity 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.JsonProperty;
import org.graylog2.contentpacks.model.entities.references.ValueReference;
import org.graylog2.database.entities.DefaultEntityScope;

import javax.annotation.Nullable;

/**
 * Base content pack entity class, which any content pack entity that supports scopes should extend.
 * This ensures that all scoped content pack entities have the same required ValueReference _scope field.
 */

public abstract class ScopedContentPackEntity {
    public static final String FIELD_SCOPE = "_scope";

    @Nullable
    @JsonProperty(FIELD_SCOPE)
    public abstract ValueReference scope();

    public abstract static class AbstractBuilder> {

        protected AbstractBuilder() {
            scope(ValueReference.of(DefaultEntityScope.NAME));
        }

        @JsonProperty(FIELD_SCOPE)
        public abstract SELF scope(ValueReference scope);
    }
}