org.apache.jackrabbit.api.security.authorization.PrivilegeManager Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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
*
* http://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.apache.jackrabbit.api.security.authorization;
import javax.jcr.AccessDeniedException;
import javax.jcr.NamespaceException;
import javax.jcr.RepositoryException;
import javax.jcr.security.AccessControlException;
import javax.jcr.security.Privilege;
/**
* PrivilegeManager
is a jackrabbit specific extensions to
* JCR access control management that allows to retrieve privileges known
* by this JCR implementation and to register new custom privileges according
* to implementation specific rules.
*
* @see javax.jcr.security.AccessControlManager#privilegeFromName(String)
*/
public interface PrivilegeManager {
/**
* Returns all registered privileges.
*
* @return all registered privileges.
* @throws RepositoryException If an error occurs.
*/
Privilege[] getRegisteredPrivileges() throws RepositoryException;
/**
* Returns the privilege with the specified privilegeName
.
*
* @param privilegeName Name of the principal.
* @return the privilege with the specified privilegeName
.
* @throws javax.jcr.security.AccessControlException If no privilege with the given name exists.
* @throws javax.jcr.RepositoryException If another error occurs.
*/
Privilege getPrivilege(String privilegeName) throws AccessControlException, RepositoryException;
/**
* Creates and registers a new custom privilege with the specified
* characteristics and returns the new privilege.
*
* If the registration succeeds, the changes are immediately effective;
* there is no need to call save
.
*
* @param privilegeName The name of the new custom privilege.
* @param isAbstract Boolean flag indicating if the privilege is abstract.
* @param declaredAggregateNames An array of privilege names referring to
* registered privileges being aggregated by this new custom privilege.
* In case of a non aggregate privilege an empty array should be passed.
* @return the new privilege.
* @throws AccessDeniedException If the session this manager has been created
* for is not allowed to register new privileges.
* @throws NamespaceException If any of the specified JCR names is illegal.
* @throws RepositoryException If the privilege could not be registered due
* to any implementation specific constraint violations or if persisting the
* custom privilege fails.
*/
Privilege registerPrivilege(String privilegeName, boolean isAbstract,
String[] declaredAggregateNames)
throws AccessDeniedException, NamespaceException, RepositoryException;
}