• Home
• net.nemerosa.ontrack
• ontrack-model
• 4.1.20
• source code
• AccountService.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

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

package net.nemerosa.ontrack.model.security;

import net.nemerosa.ontrack.model.Ack;
import net.nemerosa.ontrack.model.structure.ID;
import net.nemerosa.ontrack.model.structure.Project;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Collection;
import java.util.List;
import java.util.Optional;

/**
 * Management of accounts.
 */
public interface AccountService {

    /**
     * Completes an account with the list of its authorisations.
     *
     * @param raw Account without authorisations
     * @return Account with authorisations
     */
    @NotNull
    OntrackAuthenticatedUser withACL(@NotNull OntrackUser raw);

    /**
     * List of accounts
     */
    List getAccounts();

    /**
     * Creates a built-in account
     */
    Account create(AccountInput input);

    /**
     * Creates an account and allows for further customisation
     *
     * @param input                Account data
     * @param authenticationSource Authentication source
     */
    Account create(AccountInput input, AuthenticationSource authenticationSource);

    /**
     * Gets an account using its ID
     */
    Account getAccount(ID accountId);

    /**
     * Gets the groups for an account
     */
    List getGroupsForAccount(ID accountId);

    /**
     * Updating an existing account
     *
     * @param accountId ID of the account to update
     * @param input     Update data
     * @return Updated account
     */
    Account updateAccount(ID accountId, AccountInput input);

    /**
     * Deletes an account
     */
    Ack deleteAccount(ID accountId);

    /**
     * List of account groups
     */
    List getAccountGroups();

    /**
     * Creation of an account group
     */
    AccountGroup createGroup(AccountGroupInput input);

    /**
     * Getting a group
     */
    AccountGroup getAccountGroup(ID groupId);

    /**
     * Updating a group
     */
    AccountGroup updateGroup(ID groupId, AccountGroupInput input);

    /**
     * Deleting a group.
     */
    Ack deleteGroup(ID groupId);

    /**
     * Returns the list of all account groups, together with the status for their selection
     * in the given account ID. The account ID may not be {@link net.nemerosa.ontrack.model.structure.ID#isSet() set},
     * meaning that none of the groups will be selected.
     *
     * @param accountId Account ID to get the groups for, or not {@link net.nemerosa.ontrack.model.structure.ID#isSet() set}
     * @return List of groups with their selection status
     */
    List getAccountGroupsForSelection(ID accountId);

    /**
     * Searches for a list of permission targets using the token as a part in the
     * name of the permission target.
     */
    Collection searchPermissionTargets(String token);

    /**
     * Saves the permission for the {@link net.nemerosa.ontrack.model.security.PermissionTarget} defined
     * by the type and id.
     *
     * @param type  Group or account level permission
     * @param id    ID of the group or account
     * @param input Permissions to set
     */
    Ack saveGlobalPermission(PermissionTargetType type, int id, PermissionInput input);

    /**
     * Gets the list of global permissions.
     */
    Collection getGlobalPermissions();

    /**
     * Deletes a permission
     */
    Ack deleteGlobalPermission(PermissionTargetType type, int id);

    /**
     * Gets the list of permissions for a project.
     *
     * @param projectId ID of the project
     */
    Collection getProjectPermissions(ID projectId);

    /**
     * Saves the project permission for the {@link net.nemerosa.ontrack.model.security.PermissionTarget} defined
     * by the type and id.
     */
    Ack saveProjectPermission(ID projectId, PermissionTargetType type, int id, PermissionInput input);

    /**
     * Deletes a project permission.
     */
    Ack deleteProjectPermission(ID projectId, PermissionTargetType type, int id);

    /**
     * Gets the list of project permissions for a given account
     *
     * @param account Account to get the permissions for
     * @return List of project roles
     */
    Collection getProjectPermissionsForAccount(Account account);

    /**
     * Gets the optional global role for an account
     *
     * @param account Account
     * @return Optional role
     */
    Optional getGlobalRoleForAccount(Account account);

    /**
     * Gets the list of accounts associated with this account group.
     *
     * @param accountGroup Account group
     * @return List of accounts
     */
    List getAccountsForGroup(AccountGroup accountGroup);

    /**
     * Gets the optional global role for an account group.
     *
     * @param group Account group
     * @return Optional role
     */
    Optional getGlobalRoleForAccountGroup(AccountGroup group);

    /**
     * Gets the list of project permissions for a given account group
     *
     * @param group Account group to get the permissions for
     * @return List of project roles
     */
    Collection getProjectPermissionsForAccountGroup(AccountGroup group);

    /**
     * List of groups having the given global role
     *
     * @param globalRole Global role to search for
     * @return List of matching account groups
     */
    Collection findAccountGroupsByGlobalRole(GlobalRole globalRole);

    /**
     * List of accounts having the given global role
     *
     * @param globalRole Global role to search for
     * @return List of matching accounts
     */
    Collection findAccountsByGlobalRole(GlobalRole globalRole);

    /**
     * List of groups having the given project role
     *
     * @param project     Project
     * @param projectRole Role to search for
     * @return List of matching account groups
     */
    Collection findAccountGroupsByProjectRole(Project project, ProjectRole projectRole);

    /**
     * List of accounts having the given project role
     *
     * @param project     Project
     * @param projectRole Role to search for
     * @return List of matching accounts
     */
    Collection findAccountsByProjectRole(Project project, ProjectRole projectRole);

    /**
     * Finds an account using its name.
     *
     * @param username Name to look for
     * @return Account or null if not found
     */
    @Nullable
    Account findAccountByName(@NotNull String username);

    /**
     * Finds an account group using its name.
     *
     * @param name Name to look for
     * @return Account group or null if not found
     */
    @Nullable
    AccountGroup findAccountGroupByName(@NotNull String name);

    /**
     * Checks if an account ID exists
     */
    boolean doesAccountIdExist(@NotNull ID id);

    /**
     * Deletes all accounts having the given source.
     *
     * @param source Source to delete accounts from
     */
    void deleteAccountBySource(@NotNull AuthenticationSource source);

    /**
     * Disabled / enables an account
     */
    void setAccountDisabled(@NotNull ID id, boolean disabled);

    /**
     * Locks / unlocks an account
     */
    void setAccountLocked(@NotNull ID id, boolean locked);
}