org.bonitasoft.engine.page.AuthorizationRule Maven / Gradle / Ivy
/**
* Copyright (C) 2019 Bonitasoft S.A.
* Bonitasoft, 32 rue Gustave Eiffel - 38000 Grenoble
* 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
* version 2.1 of the License.
* 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.
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
* Floor, Boston, MA 02110-1301, USA.
**/
package org.bonitasoft.engine.page;
import java.io.Serializable;
import java.util.Map;
import org.bonitasoft.engine.commons.exceptions.SExecutionException;
/**
* Represent a rule to execute to grant access or not.
* author Emmanuel Duchastenier
*/
public interface AuthorizationRule {
/**
* Execute this rule and, according to the context, says whether the rule is valid.
*
* @param key the page mapping key
* @param context the information necessary to execute this rule.
* @return true if allowed, false otherwise.If determination cannot be fulfilled, an Exception should be thrown.
* @throws SExecutionException exception thrown if authorization cannot be determined.
*/
boolean isAllowed(String key, Map context) throws SExecutionException;
/**
* @return the identifier for this authorization rule
*/
String getId();
}