mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-24 17:32:48 +00:00
Early checkpoint of lightweight ACLs.
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@6763 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Britt Park
84
source/java/org/alfresco/service/simple/permission/ACL.java
Normal file
84
source/java/org/alfresco/service/simple/permission/ACL.java
Normal file
@@ -0,0 +1,84 @@
|
||||
/*
|
||||
* Copyright (C) 2005-2007 Alfresco Software Limited.
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU General Public License
|
||||
* as published by the Free Software Foundation; either version 2
|
||||
* of the License, or (at your option) any later version.
|
||||
|
||||
* This program 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 General Public License for more details.
|
||||
|
||||
* You should have received a copy of the GNU 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.
|
||||
|
||||
* As a special exception to the terms and conditions of version 2.0 of
|
||||
* the GPL, you may redistribute this Program in connection with Free/Libre
|
||||
* and Open Source Software ("FLOSS") applications as described in Alfresco's
|
||||
* FLOSS exception. You should have recieved a copy of the text describing
|
||||
* the FLOSS exception, and it is also available here:
|
||||
* http://www.alfresco.com/legal/licensing
|
||||
*/
|
||||
|
||||
package org.alfresco.service.simple.permission;
|
||||
|
||||
import java.io.Serializable;
|
||||
import java.util.List;
|
||||
import java.util.Set;
|
||||
|
||||
/**
|
||||
* Interface for ACLs. ACLs express the capabilities granted to
|
||||
* different agents (users, groups, or roles (one hopes that roles can go away as they are
|
||||
* operationally just another name for a group)). ACLs contain explicit entries made of
|
||||
* a capability and a list of agents plus an indication of whether the entry denies or allows
|
||||
* the capability. Entries that deny override any entries that allow.
|
||||
* @author britt
|
||||
*/
|
||||
public interface ACL extends Serializable
|
||||
{
|
||||
/**
|
||||
* Insert an allow entry for the agent, capabilities combination.
|
||||
* Removes a denials explicitly for the agent and capabilities given.
|
||||
* @param agent The agent, (user, group, role)
|
||||
* @param capabilities The capabilities being granted.
|
||||
*/
|
||||
public void allow(String agent, String ... capabilities);
|
||||
|
||||
/**
|
||||
* Insert a deny entry for the agent, capabilities combination.
|
||||
* Removes an allow explicitly for the agent and capabilities given.
|
||||
* @param agent The agent, (user, group, role)
|
||||
* @param capabilities
|
||||
*/
|
||||
public void deny(String agent, String ... capabilities);
|
||||
|
||||
/**
|
||||
* Does the given agent have the given capability
|
||||
* @param agent The agent (user)
|
||||
* @param capability The capability.
|
||||
* @return Whether the agent can.
|
||||
*/
|
||||
public boolean can(String agent, String capability);
|
||||
|
||||
/**
|
||||
* Get the capabilities for the given agent.
|
||||
* @param agent The agent.
|
||||
* @return A set of capabilities.
|
||||
*/
|
||||
public Set<String> getCapabilities(String agent);
|
||||
|
||||
/**
|
||||
* Get a string representation of this ACL, suitable for persistence.
|
||||
* @return The string representation.
|
||||
*/
|
||||
public String getStringRepresentation();
|
||||
|
||||
/**
|
||||
* Should this ACL be inherited.
|
||||
* @return Whether it should.
|
||||
*/
|
||||
public boolean inherits();
|
||||
}
|
||||
@@ -0,0 +1,66 @@
|
||||
/*
|
||||
* Copyright (C) 2005-2007 Alfresco Software Limited.
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU General Public License
|
||||
* as published by the Free Software Foundation; either version 2
|
||||
* of the License, or (at your option) any later version.
|
||||
|
||||
* This program 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 General Public License for more details.
|
||||
|
||||
* You should have received a copy of the GNU 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.
|
||||
|
||||
* As a special exception to the terms and conditions of version 2.0 of
|
||||
* the GPL, you may redistribute this Program in connection with Free/Libre
|
||||
* and Open Source Software ("FLOSS") applications as described in Alfresco's
|
||||
* FLOSS exception. You should have recieved a copy of the text describing
|
||||
* the FLOSS exception, and it is also available here:
|
||||
* http://www.alfresco.com/legal/licensing
|
||||
*/
|
||||
|
||||
package org.alfresco.service.simple.permission;
|
||||
|
||||
import java.util.Set;
|
||||
|
||||
/**
|
||||
* Interface for a registry of capabilities.
|
||||
* @author britt
|
||||
*/
|
||||
public interface CapabilityRegistry
|
||||
{
|
||||
/**
|
||||
* Get all known capabilities.
|
||||
* @return A list of all the capabilities.
|
||||
*/
|
||||
public Set<String> getAll();
|
||||
|
||||
/**
|
||||
* Get the integer id corresponding to the given capability.
|
||||
* @return The id.
|
||||
*/
|
||||
public int getCapabilityID(String capability);
|
||||
|
||||
/**
|
||||
* Get the name of a capability from it's unique id.
|
||||
* @param id
|
||||
* @return The capability name or null if the id is invalid.
|
||||
*/
|
||||
public String getCapabilityName(int id);
|
||||
|
||||
/**
|
||||
* Add a capability.
|
||||
* @param capability
|
||||
*/
|
||||
public void addCapability(String capability);
|
||||
|
||||
/**
|
||||
* Remove a capability from the system.
|
||||
* @param capability
|
||||
*/
|
||||
public void removeCapability(String capability);
|
||||
}
|
||||
@@ -0,0 +1,73 @@
|
||||
/*
|
||||
* Copyright (C) 2005-2007 Alfresco Software Limited.
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU General Public License
|
||||
* as published by the Free Software Foundation; either version 2
|
||||
* of the License, or (at your option) any later version.
|
||||
|
||||
* This program 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 General Public License for more details.
|
||||
|
||||
* You should have received a copy of the GNU 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.
|
||||
|
||||
* As a special exception to the terms and conditions of version 2.0 of
|
||||
* the GPL, you may redistribute this Program in connection with Free/Libre
|
||||
* and Open Source Software ("FLOSS") applications as described in Alfresco's
|
||||
* FLOSS exception. You should have recieved a copy of the text describing
|
||||
* the FLOSS exception, and it is also available here:
|
||||
* http://www.alfresco.com/legal/licensing
|
||||
*/
|
||||
|
||||
package org.alfresco.service.simple.permission;
|
||||
|
||||
import java.util.List;
|
||||
|
||||
/**
|
||||
* Interface for a simple permission mechanism.
|
||||
* Nothing but String valued capabilities, and ACLs.
|
||||
* @author britt
|
||||
*/
|
||||
public interface SimplePermissionService
|
||||
{
|
||||
/**
|
||||
* Can the current user perform the action indicated by the capability.
|
||||
* @param capability The capability: marker for an ability to perform an action
|
||||
* governed by an ACL.
|
||||
* @param acl The ACL. If this is null then the permission is granted.
|
||||
* @param owner The owner. The owner can always has the "changepermission" capability.
|
||||
* @return Whether permission is granted.
|
||||
*/
|
||||
boolean can(String capability, ACL acl, String owner);
|
||||
|
||||
/**
|
||||
* Can the user (agent) specified perform the action indicated by the capability.
|
||||
* @param agent The agent (user) to check.
|
||||
* @param capability The capability to check.
|
||||
* @param acl The ACL. If this is null then the permission is granted.
|
||||
* @param owner The owner.
|
||||
* @return Whether permission is granted.
|
||||
*/
|
||||
boolean can(String agent, String capability, ACL acl, String owner);
|
||||
|
||||
/**
|
||||
* Get the capabilities that this acl grants the current user.
|
||||
* @param acl The ACL.
|
||||
* @param owner The owner of the controlled entity.
|
||||
* @return A list of capabilities.
|
||||
*/
|
||||
List<String> getCapabilities(ACL acl, String owner);
|
||||
|
||||
/**
|
||||
* Get the capabilities that this agent grants the specifiec agent.
|
||||
* @param agent The agent (user).
|
||||
* @param acl The ACL.
|
||||
* @param owner The owner of the controlled entity.
|
||||
* @return A list of capabilities.
|
||||
*/
|
||||
List<String> getCapabilities(String agent, ACL acl, String owner);
|
||||
}
|
||||
Reference in New Issue
Block a user