javax.security.jacc.PolicyContext Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 1997-2013 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 javax.security.jacc;
import java.security.SecurityPermission;
import java.util.Hashtable;
import java.util.Set;
/**
* This utility class is used by containers to communicate policy context
* identifiers and other policy relevant context to Policy
* providers. Policy providers use the policy context identifier
* to select the subset of policy to apply in access decisions.
*
* The value of a policy context identifier is a
* String and each thread has an independently
* established policy context identifier.
* A container will establish the thread-scoped value
* of a policy context identifier by calling the static
* setContextID method. The value of a thread-scoped policy
* context identifier is available (to Policy) by calling the
* static getContextID method.
*
* This class is also used by Policy providers to
* request additional
* thread-scoped policy relevant context objects from the calling container.
* Containers register container-specific PolicyContext handlers
* using the static registerHandler method.
* Handler registration is scoped to the class, such that the same handler
* registrations are active in all thread contexts. Containers may
* use the static method setHandlerData to
* establish a thread-scoped parameter that will be passed to handlers
* when they are activated by Policy providers. The
* static getContext method is used to activate a
* handler and obtain the corresponding context object.
*
* The static accessor functions provided by this class
* allow per-thread policy context values to be
* established and communicated independent of a common reference to a
* particular PolicyContext instance.
*
* The PolicyContext class may encapsulate
* static ThreadLocal instance variables to represent the policy context
* identifier and handler data values.
*
* The Application server must bundle or install the PolicyContext class, and
* the containers of the application server must prevent the methods of
* the PolicyContext class from being called from calling contexts that are not
* authorized to call these methods.
* With the exception of the getContextID and GetHandlerKeys methods, containers must
* restrict and afford access to the methods of the PolicyContext class to
* calling contexts trusted by the container to perform container access decisions.
* The PolicyContext class may satisfy this requirement (on behalf
* of its container) by rejecting calls made from an AccessControlContext that has not
* been granted the "setPolicy" SecurityPermission, and by ensuring
* that Policy providers used to perform container access decisions
* are granted the "setPolicy" permission.
*
* @see javax.security.jacc.PolicyContextHandler
*
* @author Ron Monzillo
* @author Gary Ellison
*/
public final class PolicyContext {
private PolicyContext() {
}
/** This static instance variable contains the policy context identifier
* value. It's initial value is null.
*/
private static ThreadLocal thisContextID = new ThreadLocal();
/** This static instance variable contains the handler parameter data
* object. It's initial value is null.
*/
private static ThreadLocal thisHandlerData = new ThreadLocal();
/** This static instance variable contains the mapping of container
* registered PolicyContextHandler objects with the
* keys that identify the context objects returned by the handlers.
*/
private static Hashtable handlerTable = new Hashtable();
/** Authorization protected method used to modify the value of the
* policy context identifier associated with the thread on which
* this method is called.
*
* @param contextID a String that represents
* the value of the policy context identifier to be assigned to the
* PolicyContext for the calling thread. The value null
* is a legitimate value for this parameter.
*
* @throws java.lang.SecurityException
* if the calling AccessControlContext is not authorized by the container
* to call this method.
*/
public static void setContextID(String contextID)
{
java.lang.SecurityManager sm = System.getSecurityManager();
if (sm != null)
sm.checkPermission(new SecurityPermission("setPolicy"));
thisContextID.set(contextID);
}
/** This static method returns the value of the policy context identifier
* associated with the thread on which the accessor is called.
*
* @return The String (or null) policy context
* identifier established for the thread. This method must
* return the default policy context
* identifier, null, if the policy context
* identifier of the thread has not been set via setContext
* to another value.
*
* @throws java.lang.SecurityException
* if the calling AccessControlContext is not authorized by the container
* to call this method. Containers may choose to authorize calls to this
* method by any AccessControlContext.
*/
public static String getContextID()
{
return (String) thisContextID.get();
}
/** Authorization protected method that may be used to associate a
* thread-scoped handler data object with the PolicyContext.
* The handler data object will be made available to handlers,
* where it can serve to supply or bind the handler to invocation
* scoped state within the container.
*
* @param data a container-specific object that will be associated
* with the calling thread and passed to any handler activated by a
* Policy provider (on the thread).
* The value null is a legitimate value for this parameter,
* and is the value that will be used in the activation of handlers
* if the setHandlerData has not been called on the thread.
*
* @throws java.lang.SecurityException
* if the calling AccessControlContext is not authorized by the container
* to call this method.
*/
public static void setHandlerData(Object data)
{
java.lang.SecurityManager sm = System.getSecurityManager();
if (sm != null)
sm.checkPermission(new SecurityPermission("setPolicy"));
thisHandlerData.set(data);
}
/** Authorization protected method used to register a container specific
* PolicyContext handler. A handler may be registered
* to handle multiple keys, but at any time, at most one handler may be
* registered for a key.
*
* @param key a (case-sensitive) String that identifies
* the context object handled by the handler.
* The value of this parameter must not be null.
* @param handler an object that implements the
* PolicyContextHandler interface. The value of
* this parameter must not be null.
* @param replace this boolean value defines the behavior of this
* method if, when it is called, a PolicyContextHandler
* has already been registered to handle the same key.
* In that case, and if the value of this argument is true,
* the existing handler is replaced with the argument handler. If the
* value of this parameter is false the existing registration is preserved
* and an exception is thrown.
*
* @throws java.lang.IllegalArgumentException
* if the value of either of the handler or key arguments is null,
* or the value of the replace argument is false and a handler
* with the same key as the argument handler is already registered.
*
* @throws java.lang.SecurityException
* if the calling AccessControlContext is not authorized by the container
* to call this method.
*
* @throws javax.security.jacc.PolicyContextException
* if an operation by this method on the argument PolicyContextHandler
* causes it to throw a checked exception that is not accounted for
* in the signature of this method.
*/
public static void
registerHandler(String key, PolicyContextHandler handler, boolean replace)
throws javax.security.jacc.PolicyContextException
{
if (handler == null || key == null)
throw new
IllegalArgumentException("invalid (null) key or handler");
if (!handler.supports(key))
throw new IllegalArgumentException("handler does not support key");
java.lang.SecurityManager sm = System.getSecurityManager();
if (sm != null)
sm.checkPermission(new SecurityPermission("setPolicy"));
if (handlerTable.containsKey(key) && replace == false)
throw new IllegalArgumentException("handler exists");
handlerTable.put(key,handler);
}
/** This method may be used to obtain the keys that identify the
* container specific context handlers registered by the container.
*
* @return A Set, the elements of which, are the
* String key values that identify
* the handlers that have been registered
* and therefore may be activated on the PolicyContext.
*
* @throws java.lang.SecurityException
* if the calling AccessControlContext is not authorized by the container
* to call this method. Containers may choose to authorize calls to this
* method by any AccessControlContext.
*/
public static Set getHandlerKeys()
{
return handlerTable.keySet();
}
/** This method may be used by a
* Policy provider to activate the
* PolicyContextHandler registered to the context object key
* and cause it to return the corresponding policy context object from
* the container. When this method activates a handler,
* it passes to the handler the context
* object key and the handler data associated with the calling thread.
*
* @param key a String that identifies the
* PolicyContextHandler to activate and the context object
* to be acquired from the handler. The value of this parameter must
* not be null.
* @return the container and handler specific object containing
* the desired context. A null value is returned if
* the corresponding handler has been registered, and the value
* of the corresponding context is null.
*
* @throws java.lang.IllegalArgumentException
* if a PolicyContextHandler has not been registered
* for the key or the registered handler no longer supports the key.
*
* @throws java.lang.SecurityException
* if the calling AccessControlContext is not authorized by the container
* to call this method.
*
* @throws javax.security.jacc.PolicyContextException
* if an operation by this method on the identified PolicyContextHandler
* causes it to throw a checked exception that is not accounted for
* in the signature of this method.
*/
public static Object getContext(String key)
throws javax.security.jacc.PolicyContextException
{
if (key == null)
throw new IllegalArgumentException("invalid key");
PolicyContextHandler handler =
(PolicyContextHandler) handlerTable.get(key);
if (handler == null || !handler.supports(key))
throw new IllegalArgumentException("unknown handler key");
java.lang.SecurityManager sm = System.getSecurityManager();
if (sm != null)
sm.checkPermission(new SecurityPermission("setPolicy"));
return handler.getContext(key,thisHandlerData.get());
}
}