com.agiletec.aps.system.services.role.IRoleManager Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of entando-engine Show documentation
Entando Engine: an agile, modern and user-centric open source Portal platform.
There is a newer version: 6.2.27
/*
 * Copyright 2015-Present Entando Inc. (http://www.entando.com) All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library 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 GNU Lesser General Public License for more
 * details.
 */
package com.agiletec.aps.system.services.role;

import java.util.List;

import com.agiletec.aps.system.exception.ApsSystemException;

/**
 * Interfaccia base per il servizio di gestione dei ruoli.
 *
 * @author E.Santoboni
 */
public interface IRoleManager {

    public static final String ROLE_MANAGER_CACHE_NAME = "Entando_RoleManager";

    /**
     * Restituisce la lista ordinata dei ruoli esistenti.
     *
     * @return La lista ordinata dei ruoli esistenti.
     */
    public List getRoles();

    /**
     * Restituisce un ruolo in base al nome.
     *
     * @param roleName Il nome del ruolo richesto.
     * @return Il ruolo cercato.
     */
    public Role getRole(String roleName);

    /**
     * Rimuove un ruolo.
     *
     * @param role Oggetto di tipo Role relativo al ruolo da rimuovere.
     * @throws ApsSystemException in caso di errore.
     */
    public void removeRole(Role role) throws ApsSystemException;

    /**
     * Aggiorna un ruolo.
     *
     * @param role Il ruolo da aggiornare.
     * @throws ApsSystemException in caso di errore.
     */
    public void updateRole(Role role) throws ApsSystemException;

    /**
     * Aggiunge un ruolo.
     *
     * @param role Oggetto di tipo Role relativo al ruolo da aggiungere.
     * @throws ApsSystemException in caso di errore.
     */
    public void addRole(Role role) throws ApsSystemException;

    /**
     * Restituisce la lista ordinata dei permessi di autorizzazione.
     *
     * @return La lista ordinata dei permessi
     */
    public List getPermissions();

    /**
     * Restituisce un permesso in base al nome.
     *
     * @param permissionName Il nome del permesso richiesto.
     * @return Il permesso richiesto.
     */
    public Permission getPermission(String permissionName);

    /**
     * Rimuove il permesso specificato e dai ruoli.
     *
     * @param permissionName Il permesso da rimuovere dal ruolo.
     * @throws ApsSystemException in caso di errore.
     */
    public void removePermission(String permissionName) throws ApsSystemException;

    /**
     * Aggiorna un permesso di autorizzazione.
     *
     * @param permission Il permesso da aggiornare.
     * @throws ApsSystemException in caso di errore.
     */
    public void updatePermission(Permission permission) throws ApsSystemException;

    /**
     * Aggiunge un permesso di autorizzazione.
     *
     * @param permission Il permesso da aggiungere.
     * @throws ApsSystemException in caso di errore.
     */
    public void addPermission(Permission permission) throws ApsSystemException;

    /**
     * Restituisce la lista di ruoli comprendente il permesso specificato.
     *
     * @param permissionName Il nome del permesso.
     * @return La lista di ruoli.
     */
    public List getRolesWithPermission(String permissionName);

    /**
     * Return the permission codes list
     * 
     * @return the permission codes list
     */
    public List getPermissionsCodes();

}