|
Préférences
Moteurs de recherche
|
||||||||||||||||
JavaTM Platform, Enterprise Edition, v 5.0
javax.security.jacc
|
Method Summary | |
---|---|
static Object |
getContext(String key)
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. |
static String |
getContextID()
This static method returns the value of the policy context identifier associated with the thread on which the accessor is called. |
static Set |
getHandlerKeys()
This method may be used to obtain the keys that identify the container specific context handlers registered by the container. |
static void |
registerHandler(String key,
PolicyContextHandler handler,
boolean replace)
Authorization protected method used to register a container specific PolicyContext handler. |
static void |
setContextID(String contextID)
Authorization protected method used to modify the value of the policy context identifier associated with the thread on which this method is called. |
static void |
setHandlerData(Object data)
Authorization protected method that may be used to associate a thread-scoped handler data object with the PolicyContext. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static void setContextID(String contextID)
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.
SecurityException
- if the calling AccessControlContext is not authorized by the container
to call this method.public static String getContextID()
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.
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 void setHandlerData(Object data)
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.
SecurityException
- if the calling AccessControlContext is not authorized by the container
to call this method.public static void registerHandler(String key, PolicyContextHandler handler, boolean replace) throws PolicyContextException
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.
key
- a (case-sensitive) String
that identifies
the context object handled by the handler.
The value of this parameter must not be null.handler
- an object that implements the
PolicyContextHandler
interface. The value of
this parameter must not be null.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.
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.
SecurityException
- if the calling AccessControlContext is not authorized by the container
to call this method.
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 Set getHandlerKeys()
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
.
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 Object getContext(String key) throws PolicyContextException
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.
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.
null
value is returned if
the corresponding handler has been registered, and the value
of the corresponding context is null.
IllegalArgumentException
- if a PolicyContextHandler
has not been registered
for the key or the registered handler no longer supports the key.
SecurityException
- if the calling AccessControlContext is not authorized by the container
to call this method.
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.