org.graylog.grn.GRN 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.graylog.grn;

import com.google.auto.value.AutoValue;
import com.google.common.base.Splitter;
import org.graylog2.shared.security.RestPermissions;

import java.util.List;
import java.util.Locale;
import java.util.StringJoiner;

/**
 * This is a helper class for GRNs - Graylog Resource Names
 * GRNs are like URNs that we use for internal purposes only
 * 
 * 
 * GRN format:
 *   {@literal grn:::::}
 * Examples:
 * grn::::stream:000000000001
 * grn:local:0:internal:stream:000000000001
 * 
 * 
 */
@AutoValue
public abstract class GRN {
    private static final Splitter SPLITTER = Splitter.on(":").trimResults();

    public abstract String cluster();

    public abstract String tenant();

    public abstract String scope();

    public abstract String type();

    public abstract String entity();

    public abstract GRNType grnType();

    public boolean isPermissionApplicable(String permission) {
        // ENTITY_OWN is applicable to any target
        return permission.startsWith(RestPermissions.ENTITY_OWN) ||
                permission.startsWith(grnType().permissionPrefix()) ||
                // TODO Dashboard code still uses `view:` permissions
                (grnType().equals(GRNTypes.DASHBOARD) && permission.startsWith(GRNTypes.SEARCH.permissionPrefix()));
    }

    static GRN parse(String grn, GRNRegistry grnRegistry) {
        final List tokens = SPLITTER.splitToList(grn.toLowerCase(Locale.ENGLISH));

        if (tokens.size() != 6) {
            throw new IllegalArgumentException(String.format(Locale.US, "<%s> is not a valid GRN string", grn));
        }
        if (!tokens.get(0).equals("grn")) {
            throw new IllegalArgumentException(String.format(Locale.US, "<%s> is not a grn scheme", tokens.get(0)));
        }
        final String type = tokens.get(4);
        final Builder builder = grnRegistry.newGRNBuilder(type)
                .cluster(tokens.get(1))
                .tenant(tokens.get(2))
                .scope(tokens.get(3))
                .entity(tokens.get(5));

        return builder.build();
    }

    public static Builder builder() {
        return new AutoValue_GRN.Builder().cluster("").tenant("").scope("");
    }

    public abstract Builder toBuilder();

    @Override
    public String toString() {
        final StringJoiner joiner = new StringJoiner(":");
        joiner.add("grn")
                .add(cluster())
                .add(tenant())
                .add(scope())
                .add(type())
                .add(entity());

        return joiner.toString();
    }

    // We want to to ignore the permission prefix and auto-value doesn't offer a built-in way to ignore properties in equals()
    @Override
    public boolean equals(Object o) {
        if (o == this) {
            return true;
        }
        if (o instanceof GRN) {
            GRN that = (GRN) o;
            return toString().equals(that.toString());
        }
        return false;
    }

    // We want to to ignore the permission prefix and auto-value doesn't offer a built-in way to ignore properties in hashCode()
    @Override
    public int hashCode() {
        return toString().hashCode();
    }

    @AutoValue.Builder
    public abstract static class Builder {
        public abstract Builder cluster(String cluster);

        public abstract Builder tenant(String tenant);

        public abstract Builder scope(String scope);

        public abstract Builder type(String type);

        public abstract Builder entity(String entity);

        public abstract Builder grnType(GRNType grnType);

        public abstract GRN build();
    }
}