org.springframework.security.acls.model.MutableAclService Maven / Gradle / Ivy
/*
* Copyright 2004, 2005, 2006 Acegi Technology Pty Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.security.acls.model;
/**
* Provides support for creating and storing Acl
instances.
*
* @author Ben Alex
*/
public interface MutableAclService extends AclService {
/**
* Creates an empty Acl
object in the database. It will have no entries.
* The returned object will then be used to add entries.
* @param objectIdentity the object identity to create
* @return an ACL object with its ID set
* @throws AlreadyExistsException if the passed object identity already has a record
*/
MutableAcl createAcl(ObjectIdentity objectIdentity) throws AlreadyExistsException;
/**
* Removes the specified entry from the database.
* @param objectIdentity the object identity to remove
* @param deleteChildren whether to cascade the delete to children
* @throws ChildrenExistException if the deleteChildren argument was
* false
but children exist
*/
void deleteAcl(ObjectIdentity objectIdentity, boolean deleteChildren) throws ChildrenExistException;
/**
* Changes an existing Acl
in the database.
* @param acl to modify
* @throws NotFoundException if the relevant record could not be found (did you
* remember to use {@link #createAcl(ObjectIdentity)} to create the object, rather
* than creating it with the new
keyword?)
*/
MutableAcl updateAcl(MutableAcl acl) throws NotFoundException;
}