org.apache.ws.security.message

Class WSSecBase

java.lang.Object

org.apache.ws.security.message.WSSecBase

Direct Known Subclasses:

WSSecEncryptedKey, WSSecSAMLToken, WSSecSignatureBase, WSSecSignatureConfirmation, WSSecTimestamp, WSSecUsernameToken

public class WSSecBase
extends 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@apache.org)

Field Summary

Fields

Modifier and Type	Field and Description
protected CallbackLookup	callbackLookup
protected boolean	doDebug
protected int	keyIdentifierType
protected List<WSEncryptionPart>	parts
protected String	password
protected String	user

Constructor Summary

Constructors

Constructor and Description
WSSecBase()
WSSecBase(WSSConfig config)

Method Summary

Methods

Modifier and Type	Method and Description
int	getKeyIdentifierType() Gets the value of the keyIdentifierType.
WSSConfig	getWsConfig()
protected String	setBodyID(Document doc) Looks up or adds a body id.
void	setCallbackLookup(CallbackLookup callbackLookup)
void	setKeyIdentifierType(int keyIdType) Sets which key identifier to use.
void	setParts(List<WSEncryptionPart> parts) Set which parts of the message to encrypt/sign.
void	setUserInfo(String user, String password) Set the user and password info.
void	setWsConfig(WSSConfig wsConfig)
protected String	setWsuId(Element bodyElement)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

user

protected String user

password

protected String password

keyIdentifierType

protected int keyIdentifierType

parts

protected List<WSEncryptionPart> parts

doDebug

protected boolean doDebug

callbackLookup

protected CallbackLookup callbackLookup

Constructor Detail

WSSecBase

public WSSecBase()

WSSecBase

public WSSecBase(WSSConfig config)

Method Detail

setCallbackLookup

public void setCallbackLookup(CallbackLookup callbackLookup)

Parameters:

callbackLookup - The CallbackLookup object to retrieve elements

setParts

public void setParts(List<WSEncryptionPart> parts)

Set which parts of the message to encrypt/sign.

Parameters:

parts - The list containing the WSEncryptionPart objects

setKeyIdentifierType

public void setKeyIdentifierType(int keyIdType)

Sets which key identifier to use.

Defines the key identifier type to use in the method or the method function to set up the key identification elements.

Parameters:

keyIdType -

See Also:

WSConstants.ISSUER_SERIAL, WSConstants.BST_DIRECT_REFERENCE, WSConstants.X509_KEY_IDENTIFIER, WSConstants.THUMBPRINT_IDENTIFIER, WSConstants.SKI_KEY_IDENTIFIER, WSConstants.KEY_VALUE

getKeyIdentifierType

public int getKeyIdentifierType()

Gets the value of the keyIdentifierType.

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)

Parameters:

wsConfig - The wsConfig to set.

getWsConfig

public WSSConfig getWsConfig()

setBodyID

protected String setBodyID(Document doc)
                    throws Exception

Looks up or adds a body id.

First try to locate the wsu:Id in the SOAP body element. If one is found, the value of the wsu:Id attribute is returned. Otherwise the method generates a new wsu:Id and an appropriate value.

Parameters:

doc - The SOAP envelope as Document

Returns:

The value of the wsu:Id attribute of the SOAP body

Throws:

Exception

setWsuId

protected String setWsuId(Element bodyElement)

setUserInfo

public void setUserInfo(String user,
               String password)

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 document

password - The user's password to get the private signing key from the keystore