Package org.apache.ws.security.message
Class WSBaseMessage
- java.lang.Object
-
- org.apache.ws.security.message.WSBaseMessage
-
- Direct Known Subclasses:
WSAddSignatureConfirmation
,WSAddTimestamp
,WSEncryptBody
,WSSAddSAMLToken
,WSSAddUsernameToken
,WSSignEnvelope
public class WSBaseMessage extends java.lang.Object
This is the base class for WS Security messages. It provides common functions and fields used by the specific message classes such as sign, encrypt, and username token.- Author:
- Werner Dittmann (Werner.Dittmann@t-online.de)
-
-
Field Summary
Fields Modifier and Type Field Description protected java.lang.String
actor
protected boolean
doDebug
protected int
keyIdentifierType
protected boolean
mustunderstand
protected java.util.Vector
parts
protected java.lang.String
password
protected int
timeToLive
protected java.lang.String
user
protected WSSConfig
wssConfig
-
Constructor Summary
Constructors Constructor Description WSBaseMessage()
Deprecated.replaced byWSSecBase()
WSBaseMessage(java.lang.String actor)
Deprecated.replaced byWSSecBase()
andWSSecHeader
for actor specification.WSBaseMessage(java.lang.String actor, boolean mu)
Deprecated.replaced byWSSecBase()
andWSSecHeader
for actor and mustunderstand specification.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description int
getKeyIdentifierType()
Deprecated.replaced byWSSecBase.getKeyIdentifierType()
protected org.w3c.dom.Element
insertSecurityHeader(org.w3c.dom.Document doc)
Deprecated.replaced byWSSecHeader.insertSecurityHeader(Document)
void
setActor(java.lang.String act)
Deprecated.replaced byWSSecHeader.setActor(String)
protected java.lang.String
setBodyID(org.w3c.dom.Document doc)
Deprecated.replaced byWSSecBase.setBodyID(Document)
void
setKeyIdentifierType(int keyIdType)
Deprecated.replaced byWSSecBase.setKeyIdentifierType(int)
void
setMustUnderstand(boolean mu)
Deprecated.replaced byWSSecHeader.setMustUnderstand(boolean)
void
setParts(java.util.Vector parts)
Deprecated.replaced byWSSecBase.setParts(Vector)
void
setTimeToLive(int ttl)
Deprecated.replaced byWSSecTimestamp.setTimeToLive(int)
void
setUserInfo(java.lang.String user, java.lang.String password)
Deprecated.replaced byWSSecBase.setUserInfo(String, String)
void
setWsConfig(WSSConfig wsConfig)
Deprecated.replaced byWSSecBase.setWsConfig(WSSConfig)
protected java.lang.String
setWsuId(org.w3c.dom.Element bodyElement)
-
-
-
Field Detail
-
actor
protected java.lang.String actor
-
mustunderstand
protected boolean mustunderstand
-
user
protected java.lang.String user
-
password
protected java.lang.String password
-
keyIdentifierType
protected int keyIdentifierType
-
parts
protected java.util.Vector parts
-
timeToLive
protected int timeToLive
-
doDebug
protected boolean doDebug
-
wssConfig
protected WSSConfig wssConfig
-
-
Constructor Detail
-
WSBaseMessage
public WSBaseMessage()
Deprecated.replaced byWSSecBase()
Constructor.
-
WSBaseMessage
public WSBaseMessage(java.lang.String actor)
Deprecated.replaced byWSSecBase()
andWSSecHeader
for actor specification.Constructor.- Parameters:
actor
- The actor name of thewsse:Security
header
-
WSBaseMessage
public WSBaseMessage(java.lang.String actor, boolean mu)
Deprecated.replaced byWSSecBase()
andWSSecHeader
for actor and mustunderstand specification.Constructor.- Parameters:
actor
- The actor name of thewsse:Security
headermu
- SetmustUnderstand
to true or false
-
-
Method Detail
-
setActor
public void setActor(java.lang.String act)
Deprecated.replaced byWSSecHeader.setActor(String)
set actor name.- Parameters:
act
- The actor name of thewsse:Security
header
-
setTimeToLive
public void setTimeToLive(int ttl)
Deprecated.replaced byWSSecTimestamp.setTimeToLive(int)
Set the time to live. This is the time difference in seconds between theCreated
and theExpires
inTimestamp
.- Parameters:
ttl
- The time to live in second
-
setParts
public void setParts(java.util.Vector parts)
Deprecated.replaced byWSSecBase.setParts(Vector)
Set which parts of the message to encrypt/sign.- Parameters:
parts
- The vector containing the WSEncryptionPart objects
-
setMustUnderstand
public void setMustUnderstand(boolean mu)
Deprecated.replaced byWSSecHeader.setMustUnderstand(boolean)
Set themustUnderstand
flag for thewsse:Security
header- Parameters:
mu
- SetmustUnderstand
to true or false
-
setKeyIdentifierType
public void setKeyIdentifierType(int keyIdType)
Deprecated.replaced byWSSecBase.setKeyIdentifierType(int)
Sets which key identifier to use. Defines the key identifier type to use in thesignature
or theecnryption
function to set up the key identification elements.- Parameters:
keyIdType
-- See Also:
WSConstants.ISSUER_SERIAL
,WSConstants.BST_DIRECT_REFERENCE
,WSConstants.X509_KEY_IDENTIFIER
,WSConstants.SKI_KEY_IDENTIFIER
-
getKeyIdentifierType
public int getKeyIdentifierType()
Deprecated.replaced byWSSecBase.getKeyIdentifierType()
Gets the value of thekeyIdentifyerType
.- Returns:
- The
keyIdentifyerType
. - See Also:
WSConstants.ISSUER_SERIAL
,WSConstants.BST_DIRECT_REFERENCE
,WSConstants.X509_KEY_IDENTIFIER
,WSConstants.SKI_KEY_IDENTIFIER
-
setWsConfig
public void setWsConfig(WSSConfig wsConfig)
Deprecated.replaced byWSSecBase.setWsConfig(WSSConfig)
- Parameters:
wsConfig
- The wsConfig to set.
-
setBodyID
protected java.lang.String setBodyID(org.w3c.dom.Document doc) throws java.lang.Exception
Deprecated.replaced byWSSecBase.setBodyID(Document)
Looks up or adds a body id. First try to locate thewsu:Id
in the SOAP body element. If one is found, the value of thewsu:Id
attribute is returned. Otherwise the methode generates a newwsu:Id
and an appropriate value.- Parameters:
doc
- The SOAP envelope asDocument
- Returns:
- The value of the
wsu:Id
attribute of the SOAP body - Throws:
java.lang.Exception
-
setWsuId
protected java.lang.String setWsuId(org.w3c.dom.Element bodyElement)
-
setUserInfo
public void setUserInfo(java.lang.String user, java.lang.String password)
Deprecated.replaced byWSSecBase.setUserInfo(String, String)
Set the user and password info. Both information is used to get the user's private signing key.- Parameters:
user
- This is the user's alias name in the keystore that identifies the private key to sign the documentpassword
- The user's password to get the private signing key from the keystore
-
insertSecurityHeader
protected org.w3c.dom.Element insertSecurityHeader(org.w3c.dom.Document doc)
Deprecated.replaced byWSSecHeader.insertSecurityHeader(Document)
Creates a security header and inserts it as child into the SOAP Envelope. Check if a WS Security header block for an actor is already available in the document. If a header block is found return it, otherwise a new wsse:Security header block is created and the attributes set- Parameters:
doc
- A SOAP envelope asDocument
- Returns:
- A
wsse:Security
element
-
-