IBM WebSphere Application ServerTM
Release 8

com.ibm.websphere.wssecurity.wssapi.encryption
Interface WSSEncryptPart


public interface WSSEncryptPart

This interface is responsible for specifing encrypted parts. There is the value to set as default.

See Also:
WSSEncryption

Field Summary
static java.lang.String TRANSFORM_ATTACHMENT_CIPHERTEXT
          The URI for the transform algorithm, attachment ciphertext: "http://docs.oasis-open.org/wss/oasis-wss-SwAProfile-1.1#Attachment-Ciphertext-Transform.
 
Method Summary
 void addTransform(java.lang.String algorithm)
          Adds the transform method.
 void addTransform(java.lang.String algorithm, TransformParameterSpec paramSpec)
          Adds the transform method.
 void setEncryptHeader(javax.xml.namespace.QName header)
          Sets the header in the SOAP Header, specified by QName, as an encrypted part.
 void setEncryptPart(int keyword)
          Sets the keyword as an encrypted part, WSSEncryption.BODY_CONTENT or WSSEncryption.SIGNATURE.
 void setEncryptPart(SecurityToken securityToken, boolean isElement)
          Sets the security token as an encryption part.
 void setEncryptPart(WSSSignature signature)
          Sets the WSSSignature object as an encrypted part.
 void setEncryptPartByXPath(java.lang.String xpath)
          Sets an XPath expression as an encrypted part.
 

Field Detail

TRANSFORM_ATTACHMENT_CIPHERTEXT

static final java.lang.String TRANSFORM_ATTACHMENT_CIPHERTEXT
The URI for the transform algorithm, attachment ciphertext: "http://docs.oasis-open.org/wss/oasis-wss-SwAProfile-1.1#Attachment-Ciphertext-Transform.

See Also:
Constant Field Values
Method Detail

setEncryptPart

void setEncryptPart(int keyword)
                    throws WSSException
Sets the keyword as an encrypted part, WSSEncryption.BODY_CONTENT or WSSEncryption.SIGNATURE.

Parameters:
keyword - part to be encrypted
Throws:
WSSException - if the keyword is not valid.

setEncryptPart

void setEncryptPart(WSSSignature signature)
Sets the WSSSignature object as an encrypted part.

Parameters:
signature - part to be encrypted

setEncryptHeader

void setEncryptHeader(javax.xml.namespace.QName header)
Sets the header in the SOAP Header, specified by QName, as an encrypted part.

Parameters:
header - part to be encrypted

setEncryptPartByXPath

void setEncryptPartByXPath(java.lang.String xpath)
Sets an XPath expression as an encrypted part.

Parameters:
xpath - part to be encrypted

addTransform

void addTransform(java.lang.String algorithm,
                  TransformParameterSpec paramSpec)
                  throws WSSException
Adds the transform method.

Parameters:
algorithm - transform algorithm
paramSpec - specification of algorithm parameters
Throws:
WSSException

addTransform

void addTransform(java.lang.String algorithm)
                  throws WSSException
Adds the transform method.

Parameters:
algorithm - transform algorithm
Throws:
WSSException - if the algorithm is not supported

setEncryptPart

void setEncryptPart(SecurityToken securityToken,
                    boolean isElement)
Sets the security token as an encryption part.

Parameters:
securityToken - part to be encrypted
isElement - Specifies whether the encrypted part is an element. If set to true, the encrypted part is an element; if set to false, the encrypted part is its content only.

IBM WebSphere Application ServerTM
Release 8