trunk/src/modules-core/usecase/java/src/org/apache/lenya/cms/ac/usecase/UsecaseAuthorizer.java

/*
 * 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.lenya.cms.ac.usecase;

import org.apache.lenya.ac.AccessControlException;
import org.apache.lenya.ac.Authorizer;
import org.apache.lenya.ac.Role;
import org.apache.lenya.cms.publication.Publication;

/**
 * Authorizer for usecases.
 * @version $Id: UsecaseAuthorizer.java 392449 2006-04-07 23:20:38Z michi $
 */
public interface UsecaseAuthorizer extends Authorizer {

    /**
     * Authorizes a usecase by considering all roles of the current identity
     * 
     * @param usecase The usecase ID.
     * @param roles The roles of the current identity.
     * @param publication The publication.
     * @return A boolean value.
     * @throws AccessControlException when something went wrong.
     */
    boolean authorizeUsecase(String usecase, Role[] roles, Publication publication) 
            throws AccessControlException;

    /**
     * Grants or denies a usecase to a role
     *
     * @param usecase The usecase.
     * @param publication The publication.
     * @param role The role.
     * @param granted If the usecase shall be permitted.
     * @throws AccessControlException if an error occurs.
     */
    void setPermission(String usecase, Publication publication, Role role, boolean granted)
            throws AccessControlException;

    /**
     * Checks whether the specified role is permitted to invoke a given usecase
     *
     * @param usecase The usecase.
     * @param publication The publication.
     * @param role The role.
     * @return A boolean value.
     * @throws AccessControlException if an error occurs.
     */
    boolean isPermitted(String usecase, Publication publication, Role role)
            throws AccessControlException;

}