/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2000-2009 Sun Microsystems, Inc. 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.html
 * or mq/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 mq/legal/LICENSE.txt.  Sun designates
 * this particular file as subject to the "Classpath" exception as provided by
 * Sun in the GPL Version 2 section of the License file that accompanied this
 * code.  If applicable, add the following below the License Header, with the
 * fields enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyrighted [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. 
 */

/*
 * @(#)AccessControlContext.java	1.7 06/28/07
 */ 
 
package com.sun.messaging.jmq.auth.api.server;

import java.util.Properties;
import java.security.Principal;
import java.security.AccessControlException;

/**
 * An AccessControlContext encapsulates a context for the current authenticated
 * user (the subject) and permissions.  It has 2 check permission methods,
 *
 * checkConnectionPermission
 * checkDestinationPermission
 *
 * It makes these access decisions based on the context it encapsulates.
 * An object of AccessControlContext is returned from
 *
 * AuthenticationProtocolHandler.getAccessControlContext()
 *
 * after the login() (authentication) compeletes successfully.
 */

public interface AccessControlContext {

    /**
     *
     * @return The Principal that represents the client user 
     *         that associated with the subject. 
     */
    public Principal getClientUser();

    /**
     * Check connection permission based on the access control context
     *
     * @param serviceName The name of the service instance the connection belongs
     * @param serviceType The service type as in broker configuration <BR>
     *                    ("NORMAL" or "ADMIN") <BR>
     *
     * @exception AccessControlException
     */
    public void checkConnectionPermission(String serviceName,
                                          String serviceType)
                                          throws AccessControlException;

    /**
     * Check permission for an operation on a destination based on the 
     * access control context. 
     * 
     * @param serviceName The name of the service instance the connection belongs
     * @param serviceType The service type as in broker configuration <BR>
     *                    ("NORMAL" or "ADMIN") <BR>
     * @param operation "send" "receive" "publish" "subscribe" "browse"
     * @param destination The destination name
     * @param destinationType "queue" or "topic"
     *
     * @exception AccessControlException
     */
    public void checkDestinationPermission(String serviceName,
                                           String serviceType,
                                           String operation,
                                           String destination,
                                           String destinationType)
                                           throws AccessControlException; 
}
