|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.ws.security.WSPasswordCallback
public class 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 callback handle
method shall provide.
Field Summary | |
---|---|
static int |
CUSTOM_TOKEN
CUSTOM_TOKEN usage is used for the case that we want the CallbackHandler to supply a token as a DOM Element. |
static int |
DECRYPT
DECRYPT usage is used when the calling code needs a password to get the private key of this identifier (alias) from a keystore. |
static int |
ENCRYPTED_KEY_TOKEN
Deprecated. |
static int |
KEY_NAME
Deprecated. |
static int |
SECRET_KEY
SECRET_KEY usage is used for the case that we want to obtain a secret key for encryption or signature on the outbound side, or for decryption or verification on the inbound side. |
static int |
SECURITY_CONTEXT_TOKEN
SECURITY_CONTEXT_TOKEN usage is for the case of when we want the CallbackHandler to supply the key associated with a SecurityContextToken. |
static int |
SIGNATURE
SIGNATURE usage is used on the outbound side only, to get a password to get the private key of this identifier (alias) from a keystore. |
static int |
UNKNOWN
An unknown usage. |
static int |
USERNAME_TOKEN
USERNAME_TOKEN usage is used to obtain a password for either creating a Username Token, or for validating it. |
static int |
USERNAME_TOKEN_UNKNOWN
Deprecated. |
Constructor Summary | |
---|---|
WSPasswordCallback(String id,
int usage)
Constructor. |
|
WSPasswordCallback(String id,
String pw,
String type,
int usage)
Constructor. |
|
WSPasswordCallback(String id,
String pw,
String type,
int usage,
RequestData data)
Constructor. |
Method Summary | |
---|---|
Element |
getCustomToken()
|
String |
getIdentifier()
Get the identifier. |
byte[] |
getKey()
Get the key. |
String |
getPassword()
Get the password. |
RequestData |
getRequestData()
Returns the RequestData associated with the request |
String |
getType()
|
int |
getUsage()
Get the usage. |
void |
setCustomToken(Element customToken)
Set the custom token |
void |
setIdentifier(String ident)
Set the identifier |
void |
setKey(byte[] key)
Set the Key. |
void |
setPassword(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
@Deprecated public static final int KEY_NAME
@Deprecated public static final int USERNAME_TOKEN_UNKNOWN
public static final int SECURITY_CONTEXT_TOKEN
public static final int CUSTOM_TOKEN
@Deprecated public static final int ENCRYPTED_KEY_TOKEN
public static final int SECRET_KEY
Constructor Detail |
---|
public WSPasswordCallback(String id, int usage)
id
- The application called back must supply the password for
this identifier.public WSPasswordCallback(String id, String pw, String type, int usage)
id
- The application called back must supply the password for
this identifier.public WSPasswordCallback(String id, String pw, String type, int usage, RequestData data)
id
- The application called back must supply the password for
this identifier.Method Detail |
---|
public String getIdentifier()
public void setIdentifier(String ident)
ident
- The identity.public void setPassword(String passwd)
passwd
- is the password associated to the identifierpublic String getPassword()
public void setKey(byte[] key)
key
- is the key associated to the identifierpublic byte[] getKey()
public int getUsage()
public String getType()
public Element getCustomToken()
public void setCustomToken(Element customToken)
customToken
- public RequestData getRequestData()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |