com.yahoo.vespa.hosted.controller.api.role.Role Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of controller-api Show documentation
There is a newer version: 8.253.3
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.hosted.controller.api.role;

import com.yahoo.config.provision.ApplicationName;
import com.yahoo.config.provision.TenantName;

import java.util.Objects;

/**
 * A role is a combination of a {@link RoleDefinition} and a {@link Context}, which allows evaluation
 * of access control for a given action on a resource.
 *
 * @author jonmv
 */
public abstract class Role {

    private final RoleDefinition roleDefinition;
    final Context context;

    Role(RoleDefinition roleDefinition, Context context) {
        this.roleDefinition = Objects.requireNonNull(roleDefinition);
        this.context = Objects.requireNonNull(context);
    }

    /** Returns a {@link RoleDefinition#hostedOperator} for the current system. */
    public static UnboundRole hostedOperator() {
        return new UnboundRole(RoleDefinition.hostedOperator);
    }

    /** Returns a {@link RoleDefinition#hostedSupporter} for the current system. */
    public static UnboundRole hostedSupporter() {
        return new UnboundRole(RoleDefinition.hostedSupporter);
    }

    /** Returns a {@link RoleDefinition#everyone} for the current system. */
    public static UnboundRole everyone() {
        return new UnboundRole(RoleDefinition.everyone);
    }

    /** Returns a {@link RoleDefinition#athenzTenantAdmin} for the current system and given tenant. */
    public static TenantRole athenzTenantAdmin(TenantName tenant) {
        return new TenantRole(RoleDefinition.athenzTenantAdmin, tenant);
    }

    /** Returns a {@link RoleDefinition#reader} for the current system and given tenant. */
    public static TenantRole reader(TenantName tenant) {
        return new TenantRole(RoleDefinition.reader, tenant);
    }

    /** Returns a {@link RoleDefinition#developer} for the current system and given tenant. */
    public static TenantRole developer(TenantName tenant) {
        return new TenantRole(RoleDefinition.developer, tenant);
    }

    /** Returns a {@link RoleDefinition#hostedDeveloper} for the current system and given tenant. */
    public static TenantRole hostedDeveloper(TenantName tenant) {
        return new TenantRole(RoleDefinition.hostedDeveloper, tenant);
    }

    /** Returns a {@link RoleDefinition#administrator} for the current system and given tenant. */
    public static TenantRole administrator(TenantName tenant) {
        return new TenantRole(RoleDefinition.administrator, tenant);
    }

    /** Returns a {@link RoleDefinition#headless} for the current system, given tenant, and application */
    public static ApplicationRole headless(TenantName tenant, ApplicationName application) {
        return new ApplicationRole(RoleDefinition.headless, tenant, application);
    }

    /** Returns a {@link RoleDefinition#buildService} for the current system and given tenant and application. */
    public static ApplicationRole buildService(TenantName tenant, ApplicationName application) {
        return new ApplicationRole(RoleDefinition.buildService, tenant, application);
    }

    /** Returns the role for system flag deployer */
    public static UnboundRole systemFlagsDeployer() { return new UnboundRole(RoleDefinition.systemFlagsDeployer); }

    /** Returns the role for system flag dryrun */
    public static UnboundRole systemFlagsDryrunner() { return new UnboundRole(RoleDefinition.systemFlagsDryrunner); }

    /** Returns the role of the payment processor */
    public static UnboundRole paymentProcessor() { return new UnboundRole(RoleDefinition.paymentProcessor); }

    /** Returns the role of the invoice manager */
    public static UnboundRole hostedAccountant() { return new UnboundRole(RoleDefinition.hostedAccountant); }

    /** Returns the role definition of this bound role. */
    public RoleDefinition definition() { return roleDefinition; }

    /** Returns whether the other role is a parent of this, and has a context included in this role's context. */
    public boolean implies(Role other) {
        return    (context.tenant().isEmpty() || context.tenant().equals(other.context.tenant()))
               && (context.application().isEmpty() || context.application().equals(other.context.application()))
               && roleDefinition.inherited().contains(other.roleDefinition);
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Role role = (Role) o;
        return roleDefinition == role.roleDefinition &&
               Objects.equals(context, role.context);
    }

    @Override
    public int hashCode() {
        return Objects.hash(roleDefinition, context);
    }

}