net.nemerosa.ontrack.model.security.AccountGroupMappingService 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.Ack;
import net.nemerosa.ontrack.model.structure.ID;

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

/**
 * Generic mapping for the account groups.
 */
public interface AccountGroupMappingService {

    /**
     * For the given {@code mapping} type, collects the {@link AccountGroup} which are associated
     * with the {@code mappedName} name.
     *
     * @param mapping    Mapping type, for example: "ldap"
     * @param mappedName Mapping name, for example: "Administrator"
     * @return List of mapped groups, can be empty, but not null
     */
    Collection getGroups(String mapping, String mappedName);

    /**
     * For the given {@code mapping} type, collects the {@linkplain AccountGroupMapping mappings}.
     *
     * @param mapping Mapping type, for example: "ldap"
     * @return List of mappings, can be empty, but not null
     */
    List getMappings(String mapping);

    /**
     * Creates a new mapping
     *
     * @param mapping Mapping type, for example: "ldap"
     * @param input   Input data for the mapping
     * @return Created mapping
     */
    AccountGroupMapping newMapping(String mapping, AccountGroupMappingInput input);

    /**
     * Gets a mapping by its ID
     *
     * @param mapping Mapping type, for example: "ldap"
     * @param id      ID of the mapping
     * @return Mapping
     */
    AccountGroupMapping getMapping(String mapping, ID id);

    /**
     * Updates a mapping
     *
     * @param mapping Mapping type, for example: "ldap"
     * @param id      ID of the mapping
     * @param input   Input data for the mapping
     * @return Created mapping
     */
    AccountGroupMapping updateMapping(String mapping, ID id, AccountGroupMappingInput input);

    /**
     * Deletes a mapping
     *
     * @param mapping Mapping type, for example: "ldap"
     * @param id      ID of the mapping
     * @return Acknowledgment
     */
    Ack deleteMapping(String mapping, ID id);

    /**
     * Gets the list of mappings for a given group.
     *
     * @param group Group to get the mappings to
     * @return List of mappings (never null)
     */
    List getMappingsForGroup(AccountGroup group);
}