|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.ws.security.WSPasswordCallback
Simple class to provide a password callback mechanism.
It uses the JAAS authentication mechanisms and callback methods. In addition to the identifier (user name) this class also provides information what type of information the callbackhandle
method shall provide.
The WSPasswordCallback
class defines the following usage
codes:
UNKNOWN
- an unknown usage. Never used by the WSS4J
implementation and shall be treated as an error by the handle
method.DECRYPT
- need a password to get the private key of
this identifier (username) from the keystore. WSS4J uses this private
key to decrypt the session (symmetric) key. Because the encryption
method uses the public key to encrypt the session key it needs no
password (a public key is usually not protected by a password).USERNAME_TOKEN
- need the password to fill in or to
verify a UsernameToken
.SIGNATURE
- need the password to get the private key of
this identifier (username) from the keystore. WSS4J uses this private
key to produce a signature. The signature verfication uses the public
key to verfiy the signature.KEY_NAME
- need the key, not the password,
associated with the identifier. WSS4J uses this key to encrypt or
decrypt parts of the SOAP request. Note, the key must match the
symmetric encryption/decryption algorithm specified (refer to
WSHandlerConstants.ENC_SYM_ALGO
).USERNAME_TOKEN_UNKNOWN
- either an not specified
password type or a password type passwordText. In these both cases only
the password variable is set. The callback class now may check if
the username and password match. If they don't match the callback class must
throw an exception. The exception can be a UnsupportedCallbackException or
an IOException.SECURITY_CONTEXT_TOKEN
- need the key to to be associated
with a wsc:SecurityContextToken
.
Field Summary | |
static int |
DECRYPT
|
static int |
KEY_NAME
|
static int |
SECURITY_CONTEXT_TOKEN
|
static int |
SIGNATURE
|
static int |
UNKNOWN
|
static int |
USERNAME_TOKEN
|
static int |
USERNAME_TOKEN_UNKNOWN
|
Constructor Summary | |
WSPasswordCallback(java.lang.String id,
int usage)
Constructor. |
|
WSPasswordCallback(java.lang.String id,
java.lang.String pw,
java.lang.String type,
int usage)
Constructor. |
Method Summary | |
java.lang.String |
getIdentifer()
Get the identifier. |
byte[] |
getKey()
Get the key. |
java.lang.String |
getPassword()
Get the password. |
java.lang.String |
getPasswordType()
The password type is only relevant for usage USERNAME_TOKEN
and USERNAME_TOKEN_UNKNOWN . |
int |
getUsage()
Get the usage. |
void |
setKey(byte[] key)
Set the Key. |
void |
setPassword(java.lang.String passwd)
Set the password. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final int UNKNOWN
public static final int DECRYPT
public static final int USERNAME_TOKEN
public static final int SIGNATURE
public static final int KEY_NAME
public static final int USERNAME_TOKEN_UNKNOWN
public static final int SECURITY_CONTEXT_TOKEN
Constructor Detail |
public WSPasswordCallback(java.lang.String id, int usage)
id
- The application called back must supply the password for
this identifier.public WSPasswordCallback(java.lang.String id, java.lang.String pw, java.lang.String type, int usage)
id
- The application called back must supply the password for
this identifier.Method Detail |
public java.lang.String getIdentifer()
public void setPassword(java.lang.String passwd)
passwd
- is the password associated to the identifierpublic java.lang.String getPassword()
public void setKey(byte[] key)
key
- is the key associated to the identifierpublic byte[] getKey()
public int getUsage()
public java.lang.String getPasswordType()
USERNAME_TOKEN
and USERNAME_TOKEN_UNKNOWN
.
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |