javax.security.auth.message.callback
Class SecretKeyCallback

java.lang.Object
  extended by javax.security.auth.message.callback.SecretKeyCallback
All Implemented Interfaces:
javax.security.auth.callback.Callback

public class SecretKeyCallback
extends java.lang.Object
implements javax.security.auth.callback.Callback

Callback for acquiring a shared secret from a key repository. This Callback may be used by client or server authentication modules to obtain shared secrets (for example, passwords) without relying on a user during the Callback processing. This Callback is typically empoyed by ClientAuthModules invoked from intermediate components that need to acquire a password to authenticate to their target service.

Version:
%I%, %G%

Nested Class Summary
static class SecretKeyCallback.AliasRequest
          Request type for secret keys that are identified using an alias.
static interface SecretKeyCallback.Request
          Marker interface for secret key request types.
 
Constructor Summary
SecretKeyCallback(SecretKeyCallback.Request request)
          Constructs this SecretKeyCallback with a secret key Request object.
 
Method Summary
 javax.crypto.SecretKey getKey()
          Used to obtain the secret key set within the Callback.
 SecretKeyCallback.Request getRequest()
          Used by the CallbackHandler to get the Request object which identifies the secret key to be returned.
 void setKey(javax.crypto.SecretKey key)
          Used by the CallbackHandler to set the requested secret key within the Callback.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SecretKeyCallback

public SecretKeyCallback(SecretKeyCallback.Request request)
Constructs this SecretKeyCallback with a secret key Request object.

The request object identifies the secret key to be returned. If the alias is null, the handler of the callback relies on its own default.

Parameters:
request - Request object identifying the secret key, or null.
Method Detail

getRequest

public SecretKeyCallback.Request getRequest()
Used by the CallbackHandler to get the Request object which identifies the secret key to be returned.

Returns:
The Request object which identifies the private key to be returned, or null. If null, the handler of the callback relies on its own default.

setKey

public void setKey(javax.crypto.SecretKey key)
Used by the CallbackHandler to set the requested secret key within the Callback.

Parameters:
key - The secret key, or null if no key was found.

getKey

public javax.crypto.SecretKey getKey()
Used to obtain the secret key set within the Callback.

Returns:
The secret key, or null if no key was found.


Submit a bug or feature

Copyright © 2009-2011, Oracle Corporation and/or its affiliates. All Rights Reserved. Use is subject to license terms.

Generated on 10-February-2011 12:41


Spec-Zone.ru - all specs in one place



free hit counter