org.opencms.security.CmsPermissionSetCustom Maven / Gradle / Ivy
Show all versions of opencms-core Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* 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.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* 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.opencms.security;
import java.util.StringTokenizer;
/**
* A custom permission set that can be modified during runtime and contains both allowed and denied permissions as bitsets.
*
* @since 6.0.0
*/
public class CmsPermissionSetCustom extends CmsPermissionSet {
/**
* Constructor to create an empty permission set.
*/
public CmsPermissionSetCustom() {
super();
}
/**
* Constructor to create a permission set with preset allowed and denied permissions from another permission set.
*
* The permissions are read from a string representation of permissions
* in the format {{+|-}{r|w|v|c|d}}*.
*
* @param permissions the set of allowed and denied permissions
*/
public CmsPermissionSetCustom(CmsPermissionSet permissions) {
m_allowed = permissions.m_allowed;
m_denied = permissions.m_denied;
}
/**
* Constructor to create a permission set with preset allowed permissions.
*
* @param allowedPermissions bitset of allowed permissions
*/
public CmsPermissionSetCustom(int allowedPermissions) {
super(allowedPermissions);
}
/**
* Constructor to create a permission set with preset allowed and denied permissions.
*
* @param allowedPermissions the set of permissions to allow
* @param deniedPermissions the set of permissions to deny
*/
public CmsPermissionSetCustom(int allowedPermissions, int deniedPermissions) {
super(allowedPermissions, deniedPermissions);
}
/**
* Constructor to create a permission set with preset allowed and denied permissions from a String.
*
* The permissions are read from a string representation of permissions
* in the format {{+|-}{r|w|v|c|d}}*.
*
* @param permissionString the string representation of allowed and denied permissions
*/
public CmsPermissionSetCustom(String permissionString) {
StringTokenizer tok = new StringTokenizer(permissionString, "+-", true);
m_allowed = 0;
m_denied = 0;
while (tok.hasMoreElements()) {
String prefix = tok.nextToken();
String suffix = tok.nextToken();
switch (suffix.charAt(0)) {
case 'R':
case 'r':
if (prefix.charAt(0) == '+') {
m_allowed |= CmsPermissionSet.PERMISSION_READ;
}
if (prefix.charAt(0) == '-') {
m_denied |= CmsPermissionSet.PERMISSION_READ;
}
break;
case 'W':
case 'w':
if (prefix.charAt(0) == '+') {
m_allowed |= CmsPermissionSet.PERMISSION_WRITE;
}
if (prefix.charAt(0) == '-') {
m_denied |= CmsPermissionSet.PERMISSION_WRITE;
}
break;
case 'V':
case 'v':
if (prefix.charAt(0) == '+') {
m_allowed |= CmsPermissionSet.PERMISSION_VIEW;
}
if (prefix.charAt(0) == '-') {
m_denied |= CmsPermissionSet.PERMISSION_VIEW;
}
break;
case 'C':
case 'c':
if (prefix.charAt(0) == '+') {
m_allowed |= CmsPermissionSet.PERMISSION_CONTROL;
}
if (prefix.charAt(0) == '-') {
m_denied |= CmsPermissionSet.PERMISSION_CONTROL;
}
break;
case 'D':
case 'd':
if (prefix.charAt(0) == '+') {
m_allowed |= CmsPermissionSet.PERMISSION_DIRECT_PUBLISH;
}
if (prefix.charAt(0) == '-') {
m_denied |= CmsPermissionSet.PERMISSION_DIRECT_PUBLISH;
}
break;
default:
// ignore
break;
}
}
}
/**
* Sets permissions from another permission set additionally both as allowed and denied permissions.
*
* @param permissionSet the set of permissions to set additionally.
*/
public void addPermissions(CmsPermissionSet permissionSet) {
m_allowed |= permissionSet.m_allowed;
m_denied |= permissionSet.m_denied;
}
/**
* Returns a clone of this Objects instance.
*
* @return a clone of this instance
*/
@Override
public Object clone() {
return new CmsPermissionSetCustom(m_allowed, m_denied);
}
/**
* Sets permissions additionally as denied permissions.
*
* @param permissions bitset of permissions to deny
*/
public void denyPermissions(int permissions) {
m_denied |= permissions;
}
/**
* Sets permissions additionally as allowed permissions.
*
* @param permissions bitset of permissions to allow
*/
public void grantPermissions(int permissions) {
m_allowed |= permissions;
}
/**
* Set permissions from another permission set both as allowed and denied permissions.
* Permissions formerly set are overwritten.
*
* @param permissionSet the set of permissions
*/
public void setPermissions(CmsPermissionSet permissionSet) {
m_allowed = permissionSet.m_allowed;
m_denied = permissionSet.m_denied;
}
/**
* Sets permissions as allowed and denied permissions in the permission set.
* Permissions formerly set are overwritten.
*
* @param allowedPermissions bitset of permissions to allow
* @param deniedPermissions bitset of permissions to deny
*/
public void setPermissions(int allowedPermissions, int deniedPermissions) {
m_allowed = allowedPermissions;
m_denied = deniedPermissions;
}
}