AuthorizationPreprocessor.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 * 
 * Copyright (c) 2012 Oracle and/or its affiliates. All rights reserved.
 * 
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 * 
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 * 
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 * 
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 * 
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */
package org.glassfish.api.admin;

import java.util.Map;
import javax.security.auth.Subject;
import org.jvnet.hk2.annotations.Contract;

/**
 * Defines the API for services which provide additional information to be 
 * used during authorization.  
 * <p>
 * The implementations of this interface provide name/value pairs as Maps which will
 * become AzAttribute objects attached to the subject, the resource, or the action before
 * command security invokes the authorization service.  We use Maps here rather
 * than collections of AzAttributes to minimize dependencies on Az classes.
 * 
 * @author tjquinn
 */
@Contract
public interface AuthorizationPreprocessor {
    
    /**
     * Optionally adds to the attributes that will be attached to the 
     * Subject, the resource, and the action used for an upcoming authorization
     * check.
     * 
     * @param context map describing the authorization context (such as command parameter names and values)
     * @param subjectAttributes name/value pairs for attributes to be attached to the subject
     * @param resourceAttributes name/value pairs for attributes to be attached to the resource
     * @param actionAttributes name/value pairs for attributes to be attached to the action
     */
    public void describeAuthorization(
            Subject subject,
            String resourceName,
            String action,
            AdminCommand command,
            Map<String,Object> context,
            Map<String,String> subjectAttributes,
            Map<String,String> resourceAttributes,
            Map<String,String> actionAttributes);
    
}