javax.security.jacc.PolicyContextHandler Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
//
// This source code implements specifications defined by the Java
// Community Process. In order to remain compliant with the specification
// DO NOT add / change / or delete method signatures!
//
package javax.security.jacc;
/**
* This interface defines the methods that must be implemented by handlers that
* are to be registered and activated by the PolicyContext class.
* The PolicyContext class provides methods for containers to
* register and activate container-specific PolicyContext handlers.
* Policy providers use the PolicyContext class to
* activate handlers to obtain (from the container) additional policy relevant
* context to apply in their access decisions. All handlers registered and
* activated via the PolicyContext class must implement the
* PolicyContextHandler interface.
*
* @version $Rev: 467553 $ $Date: 2006-10-25 00:01:51 -0400 (Wed, 25 Oct 2006) $
*/
public interface PolicyContextHandler {
/**
* This public method returns a boolean result indicating whether or not
* the handler supports the context object identified by the
* (case-sensitive) key value.
* @param key a StringPolicyContext/ class to
* activate the handler and obtain from it the the context object
* identified by the (case-sensitive) key. In addition to the key, the
* handler will be activated with the handler data value associated within
* the PolicyContext class with the thread on which the call
* to this method is made.
*
* Note that the policy context identifier associated with a thread is
* available to the handler by calling PolicyContext.getContextID().
* @param key a String that identifies the context object to be returned by
* the handler. The value of this paramter must not be null.
* @param data the handler data Object associated with the
* thread on which the call to this method has been made. Note that the
* value passed through this parameter may be null.
* @return The container and handler specific Object
* containing the desired context. A null value may be returned if the
* value of the corresponding context is null.
* @throws PolicyContextException if the implementation throws a checked
* exception that has not been accounted for by the method signature. The
* exception thrown by the implementation class will be encapsulated
* (during construction) in the thrown PolicyContextException
*/
public Object getContext(String key, Object data) throws PolicyContextException;
}