net.nemerosa.ontrack.model.security.SecurityService Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ontrack-model Show documentation
Ontrack module: ontrack-model
There is a newer version: 4.4.5
package net.nemerosa.ontrack.model.security;

import net.nemerosa.ontrack.model.settings.SecuritySettings;
import net.nemerosa.ontrack.model.structure.ProjectEntity;
import net.nemerosa.ontrack.model.structure.Signature;

import java.util.Optional;
import java.util.function.Function;
import java.util.function.Supplier;

public interface SecurityService {

    /**
     * Gets the security settings.
     */
    SecuritySettings getSecuritySettings();

    void checkGlobalFunction(Class fn);

    boolean isGlobalFunctionGranted(Class fn);

    void checkProjectFunction(int projectId, Class fn);

    default void checkProjectFunction(ProjectEntity entity, Class fn) {
        checkProjectFunction(entity.projectId(), fn);
    }

    boolean isProjectFunctionGranted(int projectId, Class fn);

    default boolean isProjectFunctionGranted(ProjectEntity entity, Class fn) {
        return isProjectFunctionGranted(entity.projectId(), fn);
    }

    /**
     * Returns the current logged account or null if none is logged.
     */
    Account getCurrentAccount();

    /**
     * Is the current user logged?
     */
    default boolean isLogged() {
        return getCurrentAccount() != null;
    }

    /**
     * Returns the current logged account as an option
     */
    default Optional getAccount() {
        return Optional.ofNullable(getCurrentAccount());
    }

    Signature getCurrentSignature();

    /**
     * Performs a call as admin. This is mainly by internal code to access parts of the application
     * which are usually protected from the current context, but that need to be accessed locally.
     *
     * @param supplier Call to perform in a protected context
     * @param       Type of data to get back
     * @return A new supplier running in a new security context
     */
     Supplier runAsAdmin(Supplier supplier);

     T asAdmin(Supplier supplier);

    void asAdmin(Runnable task);

    Runnable runAsAdmin(Runnable task);

    /**
     * In some asynchronous operations, we need to run a task with the same credentials that initiated the operation.
     * This method creates a wrapping supplier that holds the initial security context.
     *
     * @param supplier Call to perform in a protected context
     * @param       Type of data to get back
     * @return A new supplier running in a new security context
     */
     Supplier runner(Supplier supplier);

    /**
     * In some asynchronous operations, we need to run a task with the same credentials that initiated the operation.
     * This method creates a wrapping supplier that holds the initial security context.
     *
     * @param fn  Call to perform in a protected context
     * @param  Type of data to get back
     * @return A new function running in a new security context
     */
     Function runner(Function fn);
}