Package com.sun.xml.wss.impl

Class SecurableSoapMessage

java.lang.Object

javax.xml.soap.SOAPMessage

com.sun.xml.wss.impl.SecurableSoapMessage

public final class SecurableSoapMessage
extends javax.xml.soap.SOAPMessage

Field Summary

Fields inherited from class javax.xml.soap.SOAPMessage

CHARACTER_SET_ENCODING, WRITE_XML_DECLARATION

Constructor Summary

Constructors

Constructor	Description
SecurableSoapMessage()
SecurableSoapMessage(javax.xml.soap.SOAPMessage soapMessage)

Method Summary

Modifier and Type	Method	Description
void	addAttachmentPart(javax.xml.soap.AttachmentPart AttachmentPart)
int	countAttachments()
javax.xml.soap.AttachmentPart	createAttachmentPart()
javax.xml.soap.AttachmentPart	createAttachmentPart(Object content, String contentType)
javax.xml.soap.AttachmentPart	createAttachmentPart(javax.activation.DataHandler dataHandler)
void	deleteSecurityHeader()	Delete security header
boolean	equals(Object obj)
SecurityHeader	findOrCreateSecurityHeader()	Finds or creates wsse:Security Header
SecurityHeader	findSecurityHeader()	Finds wsse:Security Header
SecurityHeader	findWsseSecurityHeaderBlock(boolean doCreate, boolean mustUnderstand)	Finds wsse:Security Header Block.
void	generateFault(WssSoapFaultException sfe)
String	generateId()
void	generateSecurityHeaderException(String exceptionMessage)	Create and initialize a SecurityHeaderException, and throw a fault based on it.
void	generateWsuId(Element element)
void	generateWsuId(Element element, String id)
javax.xml.soap.AttachmentPart	getAttachment(javax.xml.soap.SOAPElement element)
javax.xml.soap.AttachmentPart	getAttachmentPart(String uri)
Iterator	getAttachments()
Iterator	getAttachments(javax.xml.soap.MimeHeaders headers)
String	getContentDescription()
Element	getElementById(String id)
javax.xml.soap.SOAPElement	getElementByWsuId(String id)
javax.xml.soap.SOAPEnvelope	getEnvelope()
static String	getIdFromFragmentRef(String ref)
Object	getMessageParts(Target target)
javax.xml.soap.MimeHeaders	getMimeHeaders()
NamespaceContext	getNamespaceContext()
Object	getProperty(String property)
javax.xml.soap.SOAPBody	getSOAPBody()
javax.xml.soap.SOAPHeader	getSOAPHeader()
javax.xml.soap.SOAPMessage	getSOAPMessage()
javax.xml.soap.SOAPPart	getSOAPPart()
int	hashCode()
void	init(javax.xml.soap.SOAPMessage soapMessage)
boolean	isOptimized()
static WssSoapFaultException	newSOAPFaultException(String faultstring, Throwable th)	Create and initialize a WssSoapFaultException.
static WssSoapFaultException	newSOAPFaultException(QName faultCode, String faultstring, Throwable th)	Create and initialize a WssSoapFaultException.
void	removeAllAttachments()
void	removeAttachments(javax.xml.soap.MimeHeaders hdrs)
void	resetMustUnderstandOnSecHeader()	Make Security Header Non-MustUnderstand
void	saveChanges()
boolean	saveRequired()
void	setContentDescription(String description)
void	setDoNotSetMU(boolean doNotSetMU)
void	setOptimized(boolean optimized)
void	setProperty(String property, Object value)
void	setSOAPMessage(javax.xml.soap.SOAPMessage soapMsg)
String	toString()
void	writeTo(OutputStream out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SecurableSoapMessage

public SecurableSoapMessage()

SecurableSoapMessage

public SecurableSoapMessage(javax.xml.soap.SOAPMessage soapMessage)
                     throws com.sun.xml.wss.XWSSecurityException

Parameters:

soapMessage -

Throws:

com.sun.xml.wss.XWSSecurityException

Method Detail

init

public void init(javax.xml.soap.SOAPMessage soapMessage)
          throws com.sun.xml.wss.XWSSecurityException

Throws:

com.sun.xml.wss.XWSSecurityException

getEnvelope

public javax.xml.soap.SOAPEnvelope getEnvelope()
                                        throws com.sun.xml.wss.XWSSecurityException

Throws:

com.sun.xml.wss.XWSSecurityException

findWsseSecurityHeaderBlock

public SecurityHeader findWsseSecurityHeaderBlock(boolean doCreate,
                                                  boolean mustUnderstand)
                                           throws com.sun.xml.wss.XWSSecurityException

Finds wsse:Security Header Block.

Parameters:

doCreate - create one if none exists

Returns:

wsse:Security header

Throws:

com.sun.xml.wss.XWSSecurityException

findSecurityHeader

public SecurityHeader findSecurityHeader()
                                  throws com.sun.xml.wss.XWSSecurityException

Finds wsse:Security Header

Returns:

returns null if wsse:Security header not found

Throws:

com.sun.xml.wss.XWSSecurityException

findOrCreateSecurityHeader

public SecurityHeader findOrCreateSecurityHeader()
                                          throws com.sun.xml.wss.XWSSecurityException

Finds or creates wsse:Security Header

Returns:

wsse:Security header

Throws:

com.sun.xml.wss.XWSSecurityException

deleteSecurityHeader

public void deleteSecurityHeader()

Delete security header

resetMustUnderstandOnSecHeader

public void resetMustUnderstandOnSecHeader()

Make Security Header Non-MustUnderstand

generateSecurityHeaderException

public void generateSecurityHeaderException(String exceptionMessage)
                                     throws SecurityHeaderException,
                                            com.sun.xml.wss.XWSSecurityException

Create and initialize a SecurityHeaderException, and throw a fault based on it. The faultstring for this exception is wsse:InvalidSecurity as per section 12 on Error Handling of the wss SOAPMessageSecurity spec (draft 17). This fault stands for An error was discovered processing the wsse:Security header.

Throws:

SecurityHeaderException

com.sun.xml.wss.XWSSecurityException

newSOAPFaultException

public static WssSoapFaultException newSOAPFaultException(String faultstring,
                                                          Throwable th)

Create and initialize a WssSoapFaultException. This method is used in conjunction with generateClientFault.

newSOAPFaultException

public static WssSoapFaultException newSOAPFaultException(QName faultCode,
                                                          String faultstring,
                                                          Throwable th)

Create and initialize a WssSoapFaultException. This method is used in conjunction with generateClientFault.

generateFault

public void generateFault(WssSoapFaultException sfe)
                   throws com.sun.xml.wss.XWSSecurityException

Parameters:

sfe -

Throws:

com.sun.xml.wss.XWSSecurityException

getSOAPPart

public javax.xml.soap.SOAPPart getSOAPPart()

Specified by:

getSOAPPart in class javax.xml.soap.SOAPMessage

getSOAPBody

public javax.xml.soap.SOAPBody getSOAPBody()
                                    throws javax.xml.soap.SOAPException

Overrides:

getSOAPBody in class javax.xml.soap.SOAPMessage

Throws:

javax.xml.soap.SOAPException

getSOAPMessage

public javax.xml.soap.SOAPMessage getSOAPMessage()

setSOAPMessage

public void setSOAPMessage(javax.xml.soap.SOAPMessage soapMsg)
                    throws com.sun.xml.wss.XWSSecurityException

Throws:

com.sun.xml.wss.XWSSecurityException

addAttachmentPart

public void addAttachmentPart(javax.xml.soap.AttachmentPart AttachmentPart)

Specified by:

addAttachmentPart in class javax.xml.soap.SOAPMessage

countAttachments

public int countAttachments()

Specified by:

countAttachments in class javax.xml.soap.SOAPMessage

createAttachmentPart

public javax.xml.soap.AttachmentPart createAttachmentPart()

Specified by:

createAttachmentPart in class javax.xml.soap.SOAPMessage

createAttachmentPart

public javax.xml.soap.AttachmentPart createAttachmentPart(Object content,
                                                          String contentType)

Overrides:

createAttachmentPart in class javax.xml.soap.SOAPMessage

createAttachmentPart

public javax.xml.soap.AttachmentPart createAttachmentPart(javax.activation.DataHandler dataHandler)

Overrides:

createAttachmentPart in class javax.xml.soap.SOAPMessage

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getAttachments

public Iterator getAttachments()

Specified by:

getAttachments in class javax.xml.soap.SOAPMessage

getAttachments

public Iterator getAttachments(javax.xml.soap.MimeHeaders headers)

Specified by:

getAttachments in class javax.xml.soap.SOAPMessage

getContentDescription

public String getContentDescription()

Specified by:

getContentDescription in class javax.xml.soap.SOAPMessage

getMimeHeaders

public javax.xml.soap.MimeHeaders getMimeHeaders()

Specified by:

getMimeHeaders in class javax.xml.soap.SOAPMessage

getProperty

public Object getProperty(String property)
                   throws javax.xml.soap.SOAPException

Overrides:

getProperty in class javax.xml.soap.SOAPMessage

Throws:

javax.xml.soap.SOAPException

getSOAPHeader

public javax.xml.soap.SOAPHeader getSOAPHeader()
                                        throws javax.xml.soap.SOAPException

Overrides:

getSOAPHeader in class javax.xml.soap.SOAPMessage

Throws:

javax.xml.soap.SOAPException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

removeAllAttachments

public void removeAllAttachments()

Specified by:

removeAllAttachments in class javax.xml.soap.SOAPMessage

saveRequired

public boolean saveRequired()

Specified by:

saveRequired in class javax.xml.soap.SOAPMessage

setContentDescription

public void setContentDescription(String description)

Specified by:

setContentDescription in class javax.xml.soap.SOAPMessage

setProperty

public void setProperty(String property,
                        Object value)
                 throws javax.xml.soap.SOAPException

Overrides:

setProperty in class javax.xml.soap.SOAPMessage

Throws:

javax.xml.soap.SOAPException

toString

public String toString()

Overrides:

toString in class Object

writeTo

public void writeTo(OutputStream out)
             throws javax.xml.soap.SOAPException,
                    IOException

Specified by:

writeTo in class javax.xml.soap.SOAPMessage

Throws:

javax.xml.soap.SOAPException

IOException

saveChanges

public void saveChanges()
                 throws javax.xml.soap.SOAPException

Specified by:

saveChanges in class javax.xml.soap.SOAPMessage

Throws:

javax.xml.soap.SOAPException

getNamespaceContext

public NamespaceContext getNamespaceContext()
                                     throws com.sun.xml.wss.XWSSecurityException

Throws:

com.sun.xml.wss.XWSSecurityException

generateId

public String generateId()
                  throws com.sun.xml.wss.XWSSecurityException

Returns:

an ID unique w.r.t this SOAPMessage

Throws:

com.sun.xml.wss.XWSSecurityException

generateWsuId

public void generateWsuId(Element element)
                   throws com.sun.xml.wss.XWSSecurityException

Parameters:

element -

Throws:

com.sun.xml.wss.XWSSecurityException

generateWsuId

public void generateWsuId(Element element,
                          String id)
                   throws com.sun.xml.wss.XWSSecurityException

Parameters:

element -

id - ID specified should be unique in the message.

Throws:

com.sun.xml.wss.XWSSecurityException

getElementByWsuId

public javax.xml.soap.SOAPElement getElementByWsuId(String id)
                                             throws com.sun.xml.wss.XWSSecurityException

Throws:

com.sun.xml.wss.XWSSecurityException

getElementById

public Element getElementById(String id)
                       throws com.sun.xml.wss.XWSSecurityException

Throws:

com.sun.xml.wss.XWSSecurityException

getAttachmentPart

public javax.xml.soap.AttachmentPart getAttachmentPart(String uri)
                                                throws com.sun.xml.wss.XWSSecurityException

Throws:

com.sun.xml.wss.XWSSecurityException

getIdFromFragmentRef

public static String getIdFromFragmentRef(String ref)

getMessageParts

public Object getMessageParts(Target target)
                       throws com.sun.xml.wss.XWSSecurityException

Throws:

com.sun.xml.wss.XWSSecurityException

getAttachment

public javax.xml.soap.AttachmentPart getAttachment(javax.xml.soap.SOAPElement element)
                                            throws javax.xml.soap.SOAPException

Specified by:

getAttachment in class javax.xml.soap.SOAPMessage

Throws:

javax.xml.soap.SOAPException

removeAttachments

public void removeAttachments(javax.xml.soap.MimeHeaders hdrs)

Specified by:

removeAttachments in class javax.xml.soap.SOAPMessage

isOptimized

public boolean isOptimized()

setOptimized

public void setOptimized(boolean optimized)

setDoNotSetMU

public void setDoNotSetMU(boolean doNotSetMU)