01: /*
02: * JBoss, Home of Professional Open Source.
03: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
04: * as indicated by the @author tags. See the copyright.txt file in the
05: * distribution for a full listing of individual contributors.
06: *
07: * This is free software; you can redistribute it and/or modify it
08: * under the terms of the GNU Lesser General Public License as
09: * published by the Free Software Foundation; either version 2.1 of
10: * the License, or (at your option) any later version.
11: *
12: * This software is distributed in the hope that it will be useful,
13: * but WITHOUT ANY WARRANTY; without even the implied warranty of
14: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15: * Lesser General Public License for more details.
16: *
17: * You should have received a copy of the GNU Lesser General Public
18: * License along with this software; if not, write to the Free
19: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21: */
22: package javax.security.jacc;
23:
24: /** JACC interface which defines the methods that must be implemented by
25: * handlers that are to be registered and activated by PolicyContexts
26: *
27: * @see http://java.sun.com/j2ee/1.4/docs/api/
28: *
29: * @author Scott.Stark@jboss.org
30: * @author Ron Monzillo, Gary Ellison (javadoc)
31: * @version $Revision: 57196 $
32: */
33: public interface PolicyContextHandler {
34: /** Used by the PolicyContext class to activate the handler and obtain from
35: * it the context object identified by the given key. In addition
36: * to the key, the handler will be activated with the handler data value
37: * associated within the PolicyContext class with the thread on which the
38: * call to this method is made.
39: *
40: * @param key - a non-null key indicating which context to return.
41: * @param data - the possiblye null handler data Object associated with the
42: * thread on which the call to this method has been made.
43: * @return The container and handler specific Object containing the desired
44: * context. A null value may be returned if the value of the corresponding
45: * context is null.
46: * @throws PolicyContextException
47: */
48: public Object getContext(String key, Object data)
49: throws PolicyContextException;
50:
51: /** Get the keys identifying the context objects supported by this handlers
52: * getContext(String, Object) method.
53: * The value of each key supported by a handler must be a non-null String
54: * value.
55: *
56: * @return the list of supported context object keys.
57: * @throws PolicyContextException
58: */
59: public String[] getKeys() throws PolicyContextException;
60:
61: /** Query the handler to see if its getContext(String, Object) method
62: * supports the given key.
63: *
64: * @param key - the context object key to check.
65: * @return true if the key is supported, false otherwise
66: * @throws PolicyContextException
67: */
68: public boolean supports(String key) throws PolicyContextException;
69: }
|