org.tentackle.security.Permission Maven / Gradle / Ivy
Show all versions of tentackle-pdo Show documentation
/*
* Tentackle - https://tentackle.org
*
* 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.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.tentackle.security;
/**
* A security permission.
*
* Permissions are interfaces and may extend each other to
* imply other permissions.
*
* @author harald
*/
public interface Permission extends Comparable {
/**
* Gets the unique name of the permission.
* The name must conform to the rules of a java identifier,
* must be unique among all permissions and should be reasonably short.
*
* @return the name
*/
String getName();
/**
* Gets the optional internationalized description.
* May consist of more than one line.
* Will be displayed in tooltips, for example.
* Makes sense for application-specific permissions with a non-obvious purpose.
*
* @return the description, null or empty if none
*/
String getDescription();
/**
* Gets the permission interface of this implementation.
*
* @return the interface
*/
Class getPermissionInterface();
/**
* Determines whether this permission applies to given class or instances of it.
*
* @param clazz the class
* @return true if applies
*/
boolean appliesTo(Class clazz);
/**
* Checks if this requested permission implements at least one of the given permissions.
*
* @param permissions the configured permissions
* @return true if matches
*/
boolean isAllowedBy(Class... permissions);
/**
* Checks at least one of the given permissions implements this requested permission.
*
* @param permissions the configured permissions
* @return true if matches
*/
boolean isDeniedBy(Class... permissions);
}