org.jboss.web.tomcat.security
Class HttpServletRequestPolicyContextHandler
java.lang.Object
org.jboss.web.tomcat.security.HttpServletRequestPolicyContextHandler
- All Implemented Interfaces:
- PolicyContextHandler (src)
- public class HttpServletRequestPolicyContextHandler
- extends java.lang.Object
- implements PolicyContextHandler (src)
A PolicyContextHandler for the active HttpServletRequest
Method Summary |
java.lang.Object |
getContext(java.lang.String key,
java.lang.Object data)
Access the Servlet request policy context data. |
java.lang.String[] |
getKeys()
Get the keys identifying the context objects supported by this handlers
getContext(String, Object) method. |
boolean |
supports(java.lang.String key)
Query the handler to see if its getContext(String, Object) method
supports the given key. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
WEB_REQUEST_KEY
public static final java.lang.String WEB_REQUEST_KEY
- See Also:
- Constant Field Values (src)
HttpServletRequestPolicyContextHandler
public HttpServletRequestPolicyContextHandler()
getContext
public java.lang.Object getContext(java.lang.String key,
java.lang.Object data)
throws PolicyContextException (src)
- Access the Servlet request policy context data.
- Specified by:
getContext
in interface PolicyContextHandler (src)
- Parameters:
key
- - "javax.servlet.http.HttpServletRequest"data
- currently unused
- Returns:
- The active HttpServletRequest
- Throws:
PolicyContextException (src)
getKeys
public java.lang.String[] getKeys()
throws PolicyContextException (src)
- Description copied from interface:
PolicyContextHandler (src)
- Get the keys identifying the context objects supported by this handlers
getContext(String, Object) method.
The value of each key supported by a handler must be a non-null String
value.
- Specified by:
getKeys
in interface PolicyContextHandler (src)
- Returns:
- the list of supported context object keys.
- Throws:
PolicyContextException (src)
supports
public boolean supports(java.lang.String key)
throws PolicyContextException (src)
- Description copied from interface:
PolicyContextHandler (src)
- Query the handler to see if its getContext(String, Object) method
supports the given key.
- Specified by:
supports
in interface PolicyContextHandler (src)
- Parameters:
key
- - the context object key to check.
- Returns:
- true if the key is supported, false otherwise
- Throws:
PolicyContextException (src)