org.glassfish.api.admin.SelfAuthorizer Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of payara-micro Show documentation
Micro Distribution of the Payara Project
There is a newer version: 7.2024.1.Alpha1
/*
 * 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;

/**
 * Represents the ability (and responsibility) of an AdminCommand implementation
 * to provide its own authorization logic, instead of relying on the command
 * framework and the AccessRequired annotation to do so.
 * 
 * Commands with complicated authorization requirements will implement this
 * interface, in addition to the AdminCommand interface.
 * 
 * @author tjquinn
 */
public interface SelfAuthorizer {
    
    /**
     * Tells whether the Subject is authorized to execute the AdminCommand
     * which implements this interface.
     * 
     * Note that the command framework will have injected parameter values
     * into fields annotated with @Param before invoking this method, so the
     * logic in isAuthorized can use those parameters in making its decision.
     * 
     * @param ctx the AdminCommandContext for the current command execution
     * @return true if the Subject (recorded in the command context) can run the command; false otherwise.
     */
    public void authorize(Subject s, Map env);
    
}