< prev index next >
src/java.xml.ws/share/classes/javax/xml/soap/SOAPMessage.java
Print this page
*** 1,7 ****
/*
! * Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
--- 1,7 ----
/*
! * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
*** 53,68 ****
* The SOAP part of a message can be retrieved by calling the method {@code SOAPMessage.getSOAPPart()}.
* The {@code SOAPEnvelope} object is retrieved from the {@code SOAPPart}
* object, and the {@code SOAPEnvelope} object is used to retrieve the
* {@code SOAPBody} and {@code SOAPHeader} objects.
*
! * <PRE>
* SOAPPart sp = message.getSOAPPart();
* SOAPEnvelope se = sp.getEnvelope();
* SOAPBody sb = se.getBody();
* SOAPHeader sh = se.getHeader();
! * </PRE>
*
* <P>
* In addition to the mandatory {@code SOAPPart} object, a {@code SOAPMessage}
* object may contain zero or more {@code AttachmentPart} objects, each
* of which contains application-specific data. The {@code SOAPMessage}
--- 53,68 ----
* The SOAP part of a message can be retrieved by calling the method {@code SOAPMessage.getSOAPPart()}.
* The {@code SOAPEnvelope} object is retrieved from the {@code SOAPPart}
* object, and the {@code SOAPEnvelope} object is used to retrieve the
* {@code SOAPBody} and {@code SOAPHeader} objects.
*
! * <pre>{@code
* SOAPPart sp = message.getSOAPPart();
* SOAPEnvelope se = sp.getEnvelope();
* SOAPBody sb = se.getBody();
* SOAPHeader sh = se.getHeader();
! * }</pre>
*
* <P>
* In addition to the mandatory {@code SOAPPart} object, a {@code SOAPMessage}
* object may contain zero or more {@code AttachmentPart} objects, each
* of which contains application-specific data. The {@code SOAPMessage}
*** 101,110 ****
--- 101,111 ----
* @see MessageFactory
* @see AttachmentPart
* @since 1.6
*/
public abstract class SOAPMessage {
+
/**
* Specifies the character type encoding for the SOAP Message. Valid values
* include "utf-8" and "utf-16". See vendor documentation for additional
* supported values. The default is "utf-8".
*
*** 145,155 ****
*/
public abstract String getContentDescription();
/**
* Gets the SOAP part of this {@code SOAPMessage} object.
! * <P>
* {@code SOAPMessage} object contains one or more attachments, the
* SOAP Part must be the first MIME body part in the message.
*
* @return the {@code SOAPPart} object for this {@code SOAPMessage}
* object
--- 146,156 ----
*/
public abstract String getContentDescription();
/**
* Gets the SOAP part of this {@code SOAPMessage} object.
! * <p>
* {@code SOAPMessage} object contains one or more attachments, the
* SOAP Part must be the first MIME body part in the message.
*
* @return the {@code SOAPPart} object for this {@code SOAPMessage}
* object
*** 159,170 ****
/**
* Gets the SOAP Body contained in this {@code SOAPMessage} object.
*
* @return the {@code SOAPBody} object contained by this {@code SOAPMessage}
* object
! * @exception SOAPException
! * if the SOAP Body does not exist or cannot be retrieved
* @since 1.6, SAAJ 1.2
*/
public SOAPBody getSOAPBody() throws SOAPException {
throw new UnsupportedOperationException("getSOAPBody must be overridden by all subclasses of SOAPMessage");
}
--- 160,170 ----
/**
* Gets the SOAP Body contained in this {@code SOAPMessage} object.
*
* @return the {@code SOAPBody} object contained by this {@code SOAPMessage}
* object
! * @throws SOAPException if the SOAP Body does not exist or cannot be retrieved
* @since 1.6, SAAJ 1.2
*/
public SOAPBody getSOAPBody() throws SOAPException {
throw new UnsupportedOperationException("getSOAPBody must be overridden by all subclasses of SOAPMessage");
}
*** 183,193 ****
}
/**
* Removes all {@code AttachmentPart} objects that have been added
* to this {@code SOAPMessage} object.
! * <P>
* This method does not touch the SOAP part.
*/
public abstract void removeAllAttachments();
/**
--- 183,193 ----
}
/**
* Removes all {@code AttachmentPart} objects that have been added
* to this {@code SOAPMessage} object.
! * <p>
* This method does not touch the SOAP part.
*/
public abstract void removeAllAttachments();
/**
*** 210,221 ****
/**
* Retrieves all the {@code AttachmentPart} objects that have header
* entries that match the specified headers. Note that a returned
* attachment could have headers in addition to those specified.
*
! * @param headers
! * a {@code MimeHeaders} object containing the MIME
* headers for which to search
* @return an iterator over all attachments that have a header that matches
* one of the given headers
*/
public abstract Iterator getAttachments(MimeHeaders headers);
--- 210,220 ----
/**
* Retrieves all the {@code AttachmentPart} objects that have header
* entries that match the specified headers. Note that a returned
* attachment could have headers in addition to those specified.
*
! * @param headers a {@code MimeHeaders} object containing the MIME
* headers for which to search
* @return an iterator over all attachments that have a header that matches
* one of the given headers
*/
public abstract Iterator getAttachments(MimeHeaders headers);
< prev index next >