Package org.apache.ws.security.message
Class WSSecUsernameToken
- java.lang.Object
-
- org.apache.ws.security.message.WSSecBase
-
- org.apache.ws.security.message.WSSecUsernameToken
-
public class WSSecUsernameToken extends WSSecBase
Builds a WS UsernameToken. Refer to the WS specification, UsernameToken profile- Author:
- Werner Dittmann (werner@apache.org).
-
-
Constructor Summary
Constructors Constructor Description WSSecUsernameToken()
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addCreated()
Add a Created element to the UsernameToken.void
addNonce()
Add a Nonce element to the UsernameToken.void
appendToHeader(WSSecHeader secHeader)
Appends the UsernameToken element to the elements already in the Security header.org.w3c.dom.Document
build(org.w3c.dom.Document doc, WSSecHeader secHeader)
Adds a newUsernameToken
to a soap envelope.java.lang.String
getId()
Get the id generated duringprepare()
.byte[]
getSecretKey()
Get the derived secret key.org.w3c.dom.Element
getUsernameTokenElement()
Returns theUsernameToken
element.void
prepare(org.w3c.dom.Document doc)
Creates a Username token.void
prependToHeader(WSSecHeader secHeader)
Prepends the UsernameToken element to the elements already in the Security header.void
setPasswordType(java.lang.String pwType)
Defines how to construct the password element of theUsernameToken
.-
Methods inherited from class org.apache.ws.security.message.WSSecBase
getKeyIdentifierType, setBodyID, setKeyIdentifierType, setParts, setUserInfo, setWsConfig, setWsuId
-
-
-
-
Method Detail
-
setPasswordType
public void setPasswordType(java.lang.String pwType)
Defines how to construct the password element of theUsernameToken
.- Parameters:
pwType
- contains the password type. Only allowed values areWSConstants.PASSWORD_DIGEST
andWSConstants.PASSWORD_TEXT
.
-
addNonce
public void addNonce()
Add a Nonce element to the UsernameToken.
-
addCreated
public void addCreated()
Add a Created element to the UsernameToken.
-
getSecretKey
public byte[] getSecretKey()
Get the derived secret key. After theprepare()
method was called use this method to compute a derived secret key. The generation of this secret key is according to WS-Trust specification.- Returns:
- Return the derived secret key of this token or null if
prepare()
was not called before.
-
getId
public java.lang.String getId()
Get the id generated duringprepare()
. Returns the the value of wsu:Id attribute of this UsernameToken.- Returns:
- Return the wsu:Id of this token or null if
prepare()
was not called before.
-
prepare
public void prepare(org.w3c.dom.Document doc)
Creates a Username token. The method prepares and initializes a WSSec UsernameToken structure after the relevant information was set. A Before callingprepare()
all parameters such as user, password, passwordType etc. must be set. A completeUsernameToken
is constructed.- Parameters:
doc
- The SOAP enevlope as W3C document
-
prependToHeader
public void prependToHeader(WSSecHeader secHeader)
Prepends the UsernameToken element to the elements already in the Security header. The method can be called any time afterprepare()
. This allows to insert the UsernameToken element at any position in the Security header.- Parameters:
secHeader
- The security header that holds the Signature element.
-
appendToHeader
public void appendToHeader(WSSecHeader secHeader)
Appends the UsernameToken element to the elements already in the Security header. The method can be called any time afterprepare()
. This allows to insert the UsernameToken element at any position in the Security header.- Parameters:
secHeader
- The security header that holds the Signature element.
-
build
public org.w3c.dom.Document build(org.w3c.dom.Document doc, WSSecHeader secHeader)
Adds a newUsernameToken
to a soap envelope. Before callingbuild()
all parameters such as user, password, passwordType etc. must be set. A completeUsernameToken
is constructed and added to thewsse:Security
header.- Parameters:
doc
- The SOAP enevlope as W3C documentsecHeader
- The security header inside the SOAP envelope- Returns:
- Document with UsernameToken added
-
getUsernameTokenElement
public org.w3c.dom.Element getUsernameTokenElement()
Returns theUsernameToken
element. The method can be called any time afterprepare()
. This allows to insert the UsernameToken element at any position in the Security header.- Returns:
-
-