org.graylog2.streams.StreamImpl Maven / Gradle / Ivy

Go to download
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.1.4
/*
 * 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.streams;

import com.fasterxml.jackson.annotation.JsonValue;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Lists;
import com.google.common.collect.Maps;
import org.bson.types.ObjectId;
import org.graylog2.database.DbEntity;
import org.graylog2.database.PersistedImpl;
import org.graylog2.database.validators.DateValidator;
import org.graylog2.database.validators.FilledStringValidator;
import org.graylog2.database.validators.MapValidator;
import org.graylog2.database.validators.OptionalStringValidator;
import org.graylog2.indexer.IndexSet;
import org.graylog2.plugin.Tools;
import org.graylog2.plugin.database.validators.Validator;
import org.graylog2.plugin.streams.Output;
import org.graylog2.plugin.streams.Stream;
import org.graylog2.plugin.streams.StreamRule;
import org.joda.time.DateTime;

import javax.annotation.Nullable;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.Set;

import static org.graylog2.shared.security.RestPermissions.STREAMS_READ;

/**
 * Representing a single stream from the streams collection. Also provides method
 * to get all streams of this collection.
 */
@DbEntity(collection = "streams",
          readPermission = STREAMS_READ)
public class StreamImpl extends PersistedImpl implements Stream {
    public static final String FIELD_ID = "_id";
    public static final String FIELD_TITLE = "title";
    public static final String FIELD_DESCRIPTION = "description";
    public static final String FIELD_RULES = "rules";
    public static final String FIELD_OUTPUTS = "outputs";
    public static final String FIELD_CONTENT_PACK = "content_pack";
    public static final String FIELD_DISABLED = "disabled";
    public static final String FIELD_CREATED_AT = "created_at";
    public static final String FIELD_CREATOR_USER_ID = "creator_user_id";
    public static final String FIELD_MATCHING_TYPE = "matching_type";
    public static final String FIELD_DEFAULT_STREAM = "is_default_stream";
    public static final String FIELD_REMOVE_MATCHES_FROM_DEFAULT_STREAM = "remove_matches_from_default_stream";
    public static final String FIELD_INDEX_SET_ID = "index_set_id";
    public static final String EMBEDDED_ALERT_CONDITIONS = "alert_conditions";

    private final List streamRules;
    private final Set outputs;
    private final IndexSet indexSet;

    public StreamImpl(Map fields) {
        super(fields);
        this.streamRules = null;
        this.outputs = null;
        this.indexSet = null;
    }

    public StreamImpl(Map fields, IndexSet indexSet) {
        super(fields);
        this.streamRules = null;
        this.outputs = null;
        this.indexSet = indexSet;
    }

    protected StreamImpl(ObjectId id, Map fields) {
        super(id, fields);
        this.streamRules = null;
        this.outputs = null;
        this.indexSet = null;
    }

    public StreamImpl(ObjectId id, Map fields, List streamRules, Set outputs, @Nullable IndexSet indexSet) {
        super(id, fields);

        this.streamRules = streamRules;
        this.outputs = outputs;
        this.indexSet = indexSet;
    }

    @Override
    public String toString() {
        return this.id.toString() + ": \"" + this.getTitle() + "\"";
    }

    @Override
    public List getStreamRules() {
        return this.streamRules;
    }

    @Override
    public Set getOutputs() {
        return this.outputs;
    }

    @Override
    public String getTitle() {
        return (String) fields.get(FIELD_TITLE);
    }

    @Override
    public String getDescription() {
        return (String) fields.get(FIELD_DESCRIPTION);
    }

    @Override
    public void setTitle(String title) {
        fields.put(FIELD_TITLE, title);
    }

    @Override
    public void setDescription(String description) {
        fields.put(FIELD_DESCRIPTION, description);
    }

    @Override
    public Boolean getDisabled() {
        return (Boolean) fields.getOrDefault(FIELD_DISABLED, false);
    }

    @Override
    public void setDisabled(Boolean disabled) {
        fields.put(FIELD_DISABLED, disabled);
    }

    @Override
    public String getContentPack() {
        return (String) fields.get(FIELD_CONTENT_PACK);
    }

    @Override
    public void setContentPack(String contentPack) {
        fields.put(FIELD_CONTENT_PACK, contentPack);
    }

    @Override
    public Boolean isPaused() {
        Boolean disabled = getDisabled();
        return disabled != null && disabled;
    }

    @Override
    public Map asMap(List streamRules) {
        Map result = asMap();

        List> streamRulesMap = Lists.newArrayList();

        for (StreamRule streamRule : streamRules) {
            streamRulesMap.add(streamRule.asMap());
        }

        result.put(FIELD_RULES, streamRulesMap);

        return result;
    }

    @JsonValue
    @Override
    public Map asMap() {
        // We work on the result a bit to allow correct JSON serializing.
        Map result = Maps.newHashMap(fields);
        result.remove(FIELD_ID);
        result.put("id", ((ObjectId) fields.get(FIELD_ID)).toHexString());
        result.remove(FIELD_CREATED_AT);
        result.put(FIELD_CREATED_AT, Tools.getISO8601String((DateTime) fields.get(FIELD_CREATED_AT)));
        result.put(FIELD_RULES, streamRules);
        result.put(FIELD_OUTPUTS, outputs);
        result.put(FIELD_MATCHING_TYPE, getMatchingType());
        result.put(FIELD_DEFAULT_STREAM, isDefaultStream());
        result.put(FIELD_REMOVE_MATCHES_FROM_DEFAULT_STREAM, getRemoveMatchesFromDefaultStream());
        result.put(FIELD_INDEX_SET_ID, getIndexSetId());
        return result;
    }

    @Override
    public Map getValidations() {
        return ImmutableMap.builder()
                .put(FIELD_TITLE, new FilledStringValidator())
                .put(FIELD_CREATOR_USER_ID, new FilledStringValidator())
                .put(FIELD_CREATED_AT, new DateValidator())
                .put(FIELD_CONTENT_PACK, new OptionalStringValidator())
                .put(FIELD_INDEX_SET_ID, new FilledStringValidator())
                .build();
    }

    @Override
    public Map getEmbeddedValidations(String key) {
        if (EMBEDDED_ALERT_CONDITIONS.equals(key)) {
            return ImmutableMap.of(
                    "id", new FilledStringValidator(),
                    "parameters", new MapValidator());
        }

        return Collections.emptyMap();
    }

    @Override
    public MatchingType getMatchingType() {
        final String matchingTypeString = (String) fields.get(FIELD_MATCHING_TYPE);

        if (matchingTypeString == null) {
            return MatchingType.AND;
        } else {
            return MatchingType.valueOf(matchingTypeString);
        }
    }

    @Override
    public void setMatchingType(MatchingType matchingType) {
        fields.put(FIELD_MATCHING_TYPE, matchingType.toString());
    }

    @Override
    public boolean isDefaultStream() {
        return (boolean) fields.getOrDefault(FIELD_DEFAULT_STREAM, false);
    }

    @Override
    public void setDefaultStream(boolean defaultStream) {
        fields.put(FIELD_DEFAULT_STREAM, defaultStream);
    }

    @Override
    public boolean getRemoveMatchesFromDefaultStream() {
        return (boolean) fields.getOrDefault(FIELD_REMOVE_MATCHES_FROM_DEFAULT_STREAM, false);
    }

    @Override
    public void setRemoveMatchesFromDefaultStream(boolean removeMatchesFromDefaultStream) {
        fields.put(FIELD_REMOVE_MATCHES_FROM_DEFAULT_STREAM, removeMatchesFromDefaultStream);
    }

    @Override
    public IndexSet getIndexSet() {
        // The indexSet might be null because of backwards compatibility but it shouldn't be for regular streams.
        // Throw an exception if indexSet is not set to avoid losing messages!
        if (indexSet == null) {
            throw new IllegalStateException("index set must not be null! (stream id=" + getId() + " title=\"" + getTitle() + "\")");
        }
        return indexSet;
    }

    @Override
    public String getIndexSetId() {
        return (String) fields.get(FIELD_INDEX_SET_ID);
    }

    @Override
    public void setIndexSetId(String indexSetId) {
        fields.put(FIELD_INDEX_SET_ID, indexSetId);
    }
}