001package org.apache.archiva.redback.authorization;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 * http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.archiva.redback.authorization.AuthorizationDataSource;
023import org.apache.archiva.redback.authorization.AuthorizationException;
024import org.apache.archiva.redback.authorization.AuthorizationResult;
025
026/**
027 * Authorizer:
028 *
029 * @author: Jesse McConnell
030 * TODO chain of command rule processing
031 */
032public interface Authorizer
033{
034    String getId();
035
036    /**
037     *
038     * @param source
039     * @return result of authorization check can be <code>null</code>
040     * @throws AuthorizationException
041     */
042    AuthorizationResult isAuthorized( AuthorizationDataSource source )
043        throws AuthorizationException;
044
045    /**
046     * @return true if this implementation is a final one and not a wrapper
047     * @since 2.1
048     */
049    boolean isFinalImplementation();
050
051    /**
052     * @return a key to be able to customize label in UI
053     * @since 2.1
054     */
055    String getDescriptionKey();
056}