org.glassfish.contextpropagation.bootstrap.ContextAccessController Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2006-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.contextpropagation.bootstrap;
import org.glassfish.contextpropagation.InsufficientCredentialException;
import org.glassfish.contextpropagation.internal.AccessControlledMap;
public abstract class ContextAccessController {
/**
* Checks whether access of type type is allowed
* on key based on the user associated to the
* current thread.
*
* @param key the key to check access for
* @param type the type of access required
* @return true if access is allowed, false otherwise
*/
public abstract boolean isAccessAllowed(String key,
AccessControlledMap.ContextAccessLevel type);
/**
* Checks if access is allowed and throws an InsufficientCredentialException
* if access is not allowed.
* @throws InsufficientCredentialException if access could not be granted
*/
public void checkAccessAllowed(String key,
AccessControlledMap.ContextAccessLevel type)
throws InsufficientCredentialException {
if (!isAccessAllowed(key, type)) {
throw new InsufficientCredentialException();
}
}
/**
* @param key The name of a context
* @return true if everyone can read the context named by key
*/
public abstract boolean isEveryoneAllowedToRead(String key);
}