You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by gd...@apache.org on 2005/07/11 17:49:55 UTC
svn commit: r210150 [11/35] - in /webservices/axis/trunk/java: ./ etc/
modules/addressing/
modules/addressing/src/org/apache/axis2/handlers/addressing/
modules/addressing/test-resources/
modules/addressing/test/org/apache/axis2/handlers/addressing/ mod...
Modified: webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPConstants.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPConstants.java?rev=210150&r1=210149&r2=210150&view=diff
==============================================================================
--- webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPConstants.java (original)
+++ webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPConstants.java Mon Jul 11 08:49:30 2005
@@ -15,24 +15,28 @@
*/
package javax.xml.soap;
-/** The definition of constants pertaining to the SOAP 1.1 protocol. */
+/**
+ * The definition of constants pertaining to the SOAP 1.1 protocol.
+ */
public interface SOAPConstants {
- /** The namespace identifier for the SOAP envelope. */
+ /**
+ * The namespace identifier for the SOAP envelope.
+ */
public static final String URI_NS_SOAP_ENVELOPE =
- "http://schemas.xmlsoap.org/soap/envelope/";
+ "http://schemas.xmlsoap.org/soap/envelope/";
/**
* The namespace identifier for the SOAP encoding (see section 5 of
* the SOAP 1.1 specification).
*/
public static final String URI_NS_SOAP_ENCODING =
- "http://schemas.xmlsoap.org/soap/encoding/";
+ "http://schemas.xmlsoap.org/soap/encoding/";
/**
* The URI identifying the first application processing a SOAP request as the intended
* actor for a SOAP header entry (see section 4.2.2 of the SOAP 1.1 specification).
*/
public static final String URI_SOAP_ACTOR_NEXT =
- "http://schemas.xmlsoap.org/soap/actor/next";
+ "http://schemas.xmlsoap.org/soap/actor/next";
}
Modified: webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPElement.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPElement.java?rev=210150&r1=210149&r2=210150&view=diff
==============================================================================
--- webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPElement.java (original)
+++ webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPElement.java Mon Jul 11 08:49:30 2005
@@ -32,11 +32,12 @@
* Creates a new <code>SOAPElement</code> object initialized with the
* given <code>Name</code> object and adds the new element to this
* <code>SOAPElement</code> object.
- * @param name a <code>Name</code> object with the XML name for the
- * new element
+ *
+ * @param name a <code>Name</code> object with the XML name for the
+ * new element
* @return the new <code>SOAPElement</code> object that was created
- * @throws SOAPException if there is an error in creating the
- * <code>SOAPElement</code> object
+ * @throws SOAPException if there is an error in creating the
+ * <code>SOAPElement</code> object
*/
public abstract SOAPElement addChildElement(Name name) throws SOAPException;
@@ -44,46 +45,48 @@
* Creates a new <code>SOAPElement</code> object initialized with the
* given <code>String</code> object and adds the new element to this
* <code>SOAPElement</code> object.
- * @param localName a <code>String</code> giving the local name for
- * the element
+ *
+ * @param localName a <code>String</code> giving the local name for
+ * the element
* @return the new <code>SOAPElement</code> object that was created
- * @throws SOAPException if there is an error in creating the
- * <code>SOAPElement</code> object
+ * @throws SOAPException if there is an error in creating the
+ * <code>SOAPElement</code> object
*/
public abstract SOAPElement addChildElement(String localName)
- throws SOAPException;
+ throws SOAPException;
/**
* Creates a new <code>SOAPElement</code> object initialized with the
* specified local name and prefix and adds the new element to this
* <code>SOAPElement</code> object.
- * @param localName a <code>String</code> giving the local name for
- * the new element
- * @param prefix a <code>String</code> giving the namespace prefix for
- * the new element
+ *
+ * @param localName a <code>String</code> giving the local name for
+ * the new element
+ * @param prefix a <code>String</code> giving the namespace prefix for
+ * the new element
* @return the new <code>SOAPElement</code> object that was created
- * @throws SOAPException if there is an error in creating the
- * <code>SOAPElement</code> object
+ * @throws SOAPException if there is an error in creating the
+ * <code>SOAPElement</code> object
*/
public abstract SOAPElement addChildElement(String localName, String prefix)
- throws SOAPException;
+ throws SOAPException;
/**
* Creates a new <code>SOAPElement</code> object initialized with the
* specified local name, prefix, and URI and adds the new element to this
* <code>SOAPElement</code> object.
- * @param localName a <code>String</code> giving the local name for
- * the new element
- * @param prefix a <code>String</code> giving the namespace prefix for
- * the new element
- * @param uri a <code>String</code> giving the URI of the namespace
- * to which the new element belongs
+ *
+ * @param localName a <code>String</code> giving the local name for
+ * the new element
+ * @param prefix a <code>String</code> giving the namespace prefix for
+ * the new element
+ * @param uri a <code>String</code> giving the URI of the namespace
+ * to which the new element belongs
* @return the new <code>SOAPElement</code> object that was created
- * @throws SOAPException if there is an error in creating the
- * <code>SOAPElement</code> object
+ * @throws SOAPException if there is an error in creating the
+ * <code>SOAPElement</code> object
*/
- public abstract SOAPElement addChildElement(
- String localName, String prefix, String uri) throws SOAPException;
+ public abstract SOAPElement addChildElement(String localName, String prefix, String uri) throws SOAPException;
/**
* Add a <code>SOAPElement</code> as a child of this
@@ -97,72 +100,76 @@
* instance if <code>addChildElement()</code> is called on a
* <code>SOAPHeader</code>, <code>element</code> will be copied
* into an instance of a <code>SOAPHeaderElement</code>.
- *
+ * <p/>
* <P>The fragment rooted in <code>element</code> is either added
* as a whole or not at all, if there was an error.
- *
+ * <p/>
* <P>The fragment rooted in <code>element</code> cannot contain
* elements named "Envelope", "Header" or "Body" and in the SOAP
* namespace. Any namespace prefixes present in the fragment
* should be fully resolved using appropriate namespace
* declarations within the fragment itself.
- * @param element the <code>SOAPElement</code> to be added as a
- * new child
- * @return an instance representing the new SOAP element that was
- * actually added to the tree.
- * @throws SOAPException if there was an error in adding this
- * element as a child
+ *
+ * @param element the <code>SOAPElement</code> to be added as a
+ * new child
+ * @return an instance representing the new SOAP element that was
+ * actually added to the tree.
+ * @throws SOAPException if there was an error in adding this
+ * element as a child
*/
public abstract SOAPElement addChildElement(SOAPElement element)
- throws SOAPException;
+ throws SOAPException;
/**
* Creates a new <code>Text</code> object initialized with the given
* <code>String</code> and adds it to this <code>SOAPElement</code> object.
- * @param text a <code>String</code> object with the textual content to be added
- * @return the <code>SOAPElement</code> object into which
- * the new <code>Text</code> object was inserted
- * @throws SOAPException if there is an error in creating the
- * new <code>Text</code> object
+ *
+ * @param text a <code>String</code> object with the textual content to be added
+ * @return the <code>SOAPElement</code> object into which
+ * the new <code>Text</code> object was inserted
+ * @throws SOAPException if there is an error in creating the
+ * new <code>Text</code> object
*/
public abstract SOAPElement addTextNode(String text) throws SOAPException;
/**
* Adds an attribute with the specified name and value to this
* <code>SOAPElement</code> object.
- * <p>
- * @param name a <code>Name</code> object with the name of the attribute
- * @param value a <code>String</code> giving the value of the attribute
- * @return the <code>SOAPElement</code> object into which the attribute was
- * inserted
- * @throws SOAPException if there is an error in creating the
- * Attribute
+ * <p/>
+ *
+ * @param name a <code>Name</code> object with the name of the attribute
+ * @param value a <code>String</code> giving the value of the attribute
+ * @return the <code>SOAPElement</code> object into which the attribute was
+ * inserted
+ * @throws SOAPException if there is an error in creating the
+ * Attribute
*/
public abstract SOAPElement addAttribute(Name name, String value)
- throws SOAPException;
+ throws SOAPException;
/**
* Adds a namespace declaration with the specified prefix and URI to this
* <code>SOAPElement</code> object.
- * <p>
- * @param prefix a <code>String</code> giving the prefix of the namespace
- * @param uri a <CODE>String</CODE> giving
- * the prefix of the namespace
- * @return the <code>SOAPElement</code> object into which this
- * namespace declaration was inserted.
- * @throws SOAPException if there is an error in creating the
- * namespace
+ * <p/>
+ *
+ * @param prefix a <code>String</code> giving the prefix of the namespace
+ * @param uri a <CODE>String</CODE> giving
+ * the prefix of the namespace
+ * @return the <code>SOAPElement</code> object into which this
+ * namespace declaration was inserted.
+ * @throws SOAPException if there is an error in creating the
+ * namespace
*/
- public abstract SOAPElement addNamespaceDeclaration(
- String prefix, String uri) throws SOAPException;
+ public abstract SOAPElement addNamespaceDeclaration(String prefix, String uri) throws SOAPException;
/**
* Returns the value of the attribute with the specified
* name.
- * @param name a <CODE>Name</CODE> object with
- * the name of the attribute
+ *
+ * @param name a <CODE>Name</CODE> object with
+ * the name of the attribute
* @return a <CODE>String</CODE> giving the value of the
- * specified attribute
+ * specified attribute
*/
public abstract String getAttributeValue(Name name);
@@ -172,7 +179,8 @@
* used to get the attribute names, which can then be passed to
* the method <CODE>getAttributeValue</CODE> to retrieve the
* value of each attribute.
- * @return an iterator over the names of the attributes
+ *
+ * @return an iterator over the names of the attributes
*/
public abstract Iterator getAllAttributes();
@@ -181,9 +189,9 @@
* prefix.
*
* @param prefix a <CODE>String</CODE> giving
- * the prefix of the namespace for which to search
+ * the prefix of the namespace for which to search
* @return a <CODE>String</CODE> with the uri of the namespace
- * that has the given prefix
+ * that has the given prefix
*/
public abstract String getNamespaceURI(String prefix);
@@ -192,36 +200,40 @@
* can be used to get the namespace prefixes, which can then be
* passed to the method <CODE>getNamespaceURI</CODE> to retrieve
* the URI of each namespace.
- * @return an iterator over the namespace prefixes in this
- * <CODE>SOAPElement</CODE> object
+ *
+ * @return an iterator over the namespace prefixes in this
+ * <CODE>SOAPElement</CODE> object
*/
public abstract Iterator getNamespacePrefixes();
/**
* Returns the name of this <CODE>SOAPElement</CODE>
* object.
- * @return a <CODE>Name</CODE> object with the name of this
- * <CODE>SOAPElement</CODE> object
+ *
+ * @return a <CODE>Name</CODE> object with the name of this
+ * <CODE>SOAPElement</CODE> object
*/
public abstract Name getElementName();
/**
* Removes the attribute with the specified name.
- * @param name the <CODE>Name</CODE> object with
- * the name of the attribute to be removed
+ *
+ * @param name the <CODE>Name</CODE> object with
+ * the name of the attribute to be removed
* @return <CODE>true</CODE> if the attribute was removed
- * successfully; <CODE>false</CODE> if it was not
+ * successfully; <CODE>false</CODE> if it was not
*/
public abstract boolean removeAttribute(Name name);
/**
* Removes the namespace declaration corresponding to the
* given prefix.
- * @param prefix a <CODE>String</CODE> giving
- * the prefix for which to search
+ *
+ * @param prefix a <CODE>String</CODE> giving
+ * the prefix for which to search
* @return <CODE>true</CODE> if the namespace declaration was
- * removed successfully; <CODE>false</CODE> if it was
- * not
+ * removed successfully; <CODE>false</CODE> if it was
+ * not
*/
public abstract boolean removeNamespaceDeclaration(String prefix);
@@ -229,45 +241,50 @@
* Returns an iterator over all the immediate content of
* this element. This includes <CODE>Text</CODE> objects as well
* as <CODE>SOAPElement</CODE> objects.
- * @return an iterator with the content of this <CODE>
- * SOAPElement</CODE> object
+ *
+ * @return an iterator with the content of this <CODE>
+ * SOAPElement</CODE> object
*/
public abstract Iterator getChildElements();
/**
* Returns an iterator over all the child elements with the
* specified name.
- * @param name a <CODE>Name</CODE> object with
- * the name of the child elements to be returned
+ *
+ * @param name a <CODE>Name</CODE> object with
+ * the name of the child elements to be returned
* @return an <CODE>Iterator</CODE> object over all the elements
- * in this <CODE>SOAPElement</CODE> object with the
- * specified name
+ * in this <CODE>SOAPElement</CODE> object with the
+ * specified name
*/
public abstract Iterator getChildElements(Name name);
/**
* Sets the encoding style for this <CODE>SOAPElement</CODE>
* object to one specified.
- * @param encodingStyle a <CODE>String</CODE>
- * giving the encoding style
- * @throws java.lang.IllegalArgumentException if
- * there was a problem in the encoding style being set.
+ *
+ * @param encodingStyle a <CODE>String</CODE>
+ * giving the encoding style
+ * @throws java.lang.IllegalArgumentException
+ * if
+ * there was a problem in the encoding style being set.
* @see #getEncodingStyle() getEncodingStyle()
*/
public abstract void setEncodingStyle(String encodingStyle)
- throws SOAPException;
+ throws SOAPException;
/**
* Returns the encoding style for this <CODE>
* SOAPElement</CODE> object.
- * @return a <CODE>String</CODE> giving the encoding style
+ *
+ * @return a <CODE>String</CODE> giving the encoding style
* @see #setEncodingStyle(java.lang.String) setEncodingStyle(java.lang.String)
*/
public abstract String getEncodingStyle();
/**
* Detaches all children of this <code>SOAPElement</code>.
- * <p>
+ * <p/>
* This method is useful for rolling back the construction of partially
* completed <code>SOAPHeaders</code> and <code>SOAPBodys</code> in
* reparation for sending a fault when an error condition is detected. It is
@@ -282,7 +299,7 @@
* to retrieve the URI of each namespace.
*
* @return an iterator over the namespace prefixes are within scope of this
- * <code>SOAPElement</code> object
+ * <code>SOAPElement</code> object
*/
public abstract Iterator getVisibleNamespacePrefixes();
}
Modified: webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPElementFactory.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPElementFactory.java?rev=210150&r1=210149&r2=210150&view=diff
==============================================================================
--- webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPElementFactory.java (original)
+++ webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPElementFactory.java Mon Jul 11 08:49:30 2005
@@ -21,20 +21,21 @@
* fragments can be inserted as children of the <CODE>
* SOAPHeader</CODE> or <CODE>SOAPBody</CODE> or <CODE>
* SOAPEnvelope</CODE>.</P>
- *
+ * <p/>
* <P>Elements created using this factory do not have the
* properties of an element that lives inside a SOAP header
* document. These elements are copied into the XML document tree
* when they are inserted.</P>
- * @deprecated - Use javax.xml.soap.SOAPFactory for creating SOAPElements.
+ *
* @see SOAPFactory SOAPFactory
+ * @deprecated - Use javax.xml.soap.SOAPFactory for creating SOAPElements.
*/
public class SOAPElementFactory {
/**
* Create a new <code>SOAPElementFactory from a <code>SOAPFactory</code>.
*
- * @param soapfactory the <code>SOAPFactory</code> to use
+ * @param soapfactory the <code>SOAPFactory</code> to use
*/
private SOAPElementFactory(SOAPFactory soapfactory) {
sf = soapfactory;
@@ -43,14 +44,15 @@
/**
* Create a <CODE>SOAPElement</CODE> object initialized with
* the given <CODE>Name</CODE> object.
- * @param name a <CODE>Name</CODE> object with
- * the XML name for the new element
+ *
+ * @param name a <CODE>Name</CODE> object with
+ * the XML name for the new element
* @return the new <CODE>SOAPElement</CODE> object that was
- * created
- * @throws SOAPException if there is an error in
- * creating the <CODE>SOAPElement</CODE> object
- * @deprecated Use javax.xml.soap.SOAPFactory.createElement(javax.xml.soap.Name) instead
+ * created
+ * @throws SOAPException if there is an error in
+ * creating the <CODE>SOAPElement</CODE> object
* @see SOAPFactory#createElement(javax.xml.soap.Name) SOAPFactory.createElement(javax.xml.soap.Name)
+ * @deprecated Use javax.xml.soap.SOAPFactory.createElement(javax.xml.soap.Name) instead
*/
public SOAPElement create(Name name) throws SOAPException {
return sf.createElement(name);
@@ -59,14 +61,15 @@
/**
* Create a <CODE>SOAPElement</CODE> object initialized with
* the given local name.
- * @param localName a <CODE>String</CODE> giving
- * the local name for the new element
+ *
+ * @param localName a <CODE>String</CODE> giving
+ * the local name for the new element
* @return the new <CODE>SOAPElement</CODE> object that was
- * created
- * @throws SOAPException if there is an error in
- * creating the <CODE>SOAPElement</CODE> object
- * @deprecated Use javax.xml.soap.SOAPFactory.createElement(String localName) instead
+ * created
+ * @throws SOAPException if there is an error in
+ * creating the <CODE>SOAPElement</CODE> object
* @see SOAPFactory#createElement(java.lang.String) SOAPFactory.createElement(java.lang.String)
+ * @deprecated Use javax.xml.soap.SOAPFactory.createElement(String localName) instead
*/
public SOAPElement create(String localName) throws SOAPException {
return sf.createElement(localName);
@@ -75,19 +78,20 @@
/**
* Create a new <CODE>SOAPElement</CODE> object with the
* given local name, prefix and uri.
- * @param localName a <CODE>String</CODE> giving
- * the local name for the new element
- * @param prefix the prefix for this <CODE>
- * SOAPElement</CODE>
- * @param uri a <CODE>String</CODE> giving the
- * URI of the namespace to which the new element
- * belongs
+ *
+ * @param localName a <CODE>String</CODE> giving
+ * the local name for the new element
+ * @param prefix the prefix for this <CODE>
+ * SOAPElement</CODE>
+ * @param uri a <CODE>String</CODE> giving the
+ * URI of the namespace to which the new element
+ * belongs
* @return the new <CODE>SOAPElement</CODE> object that was
- * created
- * @throws SOAPException if there is an error in
- * creating the <CODE>SOAPElement</CODE> object
- * @deprecated Use javax.xml.soap.SOAPFactory.createElement(String localName, String prefix, String uri) instead
+ * created
+ * @throws SOAPException if there is an error in
+ * creating the <CODE>SOAPElement</CODE> object
* @see SOAPFactory#createElement(java.lang.String, java.lang.String, java.lang.String) SOAPFactory.createElement(java.lang.String, java.lang.String, java.lang.String)
+ * @deprecated Use javax.xml.soap.SOAPFactory.createElement(String localName, String prefix, String uri) instead
*/
public SOAPElement create(String localName, String prefix, String uri)
throws SOAPException {
@@ -98,9 +102,9 @@
* Creates a new instance of <CODE>SOAPElementFactory</CODE>.
*
* @return a new instance of a <CODE>
- * SOAPElementFactory</CODE>
- * @throws SOAPException if there was an error creating
- * the default <CODE>SOAPElementFactory
+ * SOAPElementFactory</CODE>
+ * @throws SOAPException if there was an error creating
+ * the default <CODE>SOAPElementFactory
*/
public static SOAPElementFactory newInstance() throws SOAPException {
Modified: webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPEnvelope.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPEnvelope.java?rev=210150&r1=210149&r2=210150&view=diff
==============================================================================
--- webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPEnvelope.java (original)
+++ webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPEnvelope.java Mon Jul 11 08:49:30 2005
@@ -17,175 +17,180 @@
/**
* The container for the SOAPHeader and SOAPBody portions of a
- * <CODE>SOAPPart</CODE> object. By default, a <CODE>
- * SOAPMessage</CODE> object is created with a <CODE>
- * SOAPPart</CODE> object that has a <CODE>SOAPEnvelope</CODE>
- * object. The <CODE>SOAPEnvelope</CODE> object by default has an
- * empty <CODE>SOAPBody</CODE> object and an empty <CODE>
- * SOAPHeader</CODE> object. The <CODE>SOAPBody</CODE> object is
- * required, and the <CODE>SOAPHeader</CODE> object, though
- * optional, is used in the majority of cases. If the <CODE>
- * SOAPHeader</CODE> object is not needed, it can be deleted,
- * which is shown later.</P>
- *
- * <P>A client can access the <CODE>SOAPHeader</CODE> and <CODE>
- * SOAPBody</CODE> objects by calling the methods <CODE>
- * SOAPEnvelope.getHeader</CODE> and <CODE>
- * SOAPEnvelope.getBody</CODE>. The following lines of code use
- * these two methods after starting with the <CODE>
- * SOAPMessage</CODE> object <I>message</I> to get the <CODE>
- * SOAPPart</CODE> object <I>sp</I>, which is then used to get the
- * <CODE>SOAPEnvelope</CODE> object <I>se</I>.</P>
+ * <CODE>SOAPPart</CODE> object. By default, a <CODE>
+ * SOAPMessage</CODE> object is created with a <CODE>
+ * SOAPPart</CODE> object that has a <CODE>SOAPEnvelope</CODE>
+ * object. The <CODE>SOAPEnvelope</CODE> object by default has an
+ * empty <CODE>SOAPBody</CODE> object and an empty <CODE>
+ * SOAPHeader</CODE> object. The <CODE>SOAPBody</CODE> object is
+ * required, and the <CODE>SOAPHeader</CODE> object, though
+ * optional, is used in the majority of cases. If the <CODE>
+ * SOAPHeader</CODE> object is not needed, it can be deleted,
+ * which is shown later.</P>
+ * <p/>
+ * <P>A client can access the <CODE>SOAPHeader</CODE> and <CODE>
+ * SOAPBody</CODE> objects by calling the methods <CODE>
+ * SOAPEnvelope.getHeader</CODE> and <CODE>
+ * SOAPEnvelope.getBody</CODE>. The following lines of code use
+ * these two methods after starting with the <CODE>
+ * SOAPMessage</CODE> object <I>message</I> to get the <CODE>
+ * SOAPPart</CODE> object <I>sp</I>, which is then used to get the
+ * <CODE>SOAPEnvelope</CODE> object <I>se</I>.</P>
* <PRE>
- * SOAPPart sp = message.getSOAPPart();
- * SOAPEnvelope se = sp.getEnvelope();
- * SOAPHeader sh = se.getHeader();
- * SOAPBody sb = se.getBody();
+ * SOAPPart sp = message.getSOAPPart();
+ * SOAPEnvelope se = sp.getEnvelope();
+ * SOAPHeader sh = se.getHeader();
+ * SOAPBody sb = se.getBody();
* </PRE>
- *
- * <P>It is possible to change the body or header of a <CODE>
- * SOAPEnvelope</CODE> object by retrieving the current one,
- * deleting it, and then adding a new body or header. The <CODE>
- * javax.xml.soap.Node</CODE> method <CODE>detachNode</CODE>
- * detaches the XML element (node) on which it is called. For
- * example, the following line of code deletes the <CODE>
- * SOAPBody</CODE> object that is retrieved by the method <CODE>
- * getBody</CODE>.</P>
+ * <p/>
+ * <P>It is possible to change the body or header of a <CODE>
+ * SOAPEnvelope</CODE> object by retrieving the current one,
+ * deleting it, and then adding a new body or header. The <CODE>
+ * javax.xml.soap.Node</CODE> method <CODE>detachNode</CODE>
+ * detaches the XML element (node) on which it is called. For
+ * example, the following line of code deletes the <CODE>
+ * SOAPBody</CODE> object that is retrieved by the method <CODE>
+ * getBody</CODE>.</P>
* <PRE>
- * se.getBody().detachNode();
+ * se.getBody().detachNode();
* </PRE>
- * To create a <CODE>SOAPHeader</CODE> object to replace the one
- * that was removed, a client uses the method <CODE>
- * SOAPEnvelope.addHeader</CODE>, which creates a new header and
- * adds it to the <CODE>SOAPEnvelope</CODE> object. Similarly, the
- * method <CODE>addBody</CODE> creates a new <CODE>SOAPBody</CODE>
- * object and adds it to the <CODE>SOAPEnvelope</CODE> object. The
- * following code fragment retrieves the current header, removes
- * it, and adds a new one. Then it retrieves the current body,
- * removes it, and adds a new one.
+ * To create a <CODE>SOAPHeader</CODE> object to replace the one
+ * that was removed, a client uses the method <CODE>
+ * SOAPEnvelope.addHeader</CODE>, which creates a new header and
+ * adds it to the <CODE>SOAPEnvelope</CODE> object. Similarly, the
+ * method <CODE>addBody</CODE> creates a new <CODE>SOAPBody</CODE>
+ * object and adds it to the <CODE>SOAPEnvelope</CODE> object. The
+ * following code fragment retrieves the current header, removes
+ * it, and adds a new one. Then it retrieves the current body,
+ * removes it, and adds a new one.
* <PRE>
- * SOAPPart sp = message.getSOAPPart();
- * SOAPEnvelope se = sp.getEnvelope();
- * se.getHeader().detachNode();
- * SOAPHeader sh = se.addHeader();
- * se.getBody().detachNode();
- * SOAPBody sb = se.addBody();
+ * SOAPPart sp = message.getSOAPPart();
+ * SOAPEnvelope se = sp.getEnvelope();
+ * se.getHeader().detachNode();
+ * SOAPHeader sh = se.addHeader();
+ * se.getBody().detachNode();
+ * SOAPBody sb = se.addBody();
* </PRE>
- * It is an error to add a <CODE>SOAPBody</CODE> or <CODE>
- * SOAPHeader</CODE> object if one already exists.
- *
- * <P>The <CODE>SOAPEnvelope</CODE> interface provides three
- * methods for creating <CODE>Name</CODE> objects. One method
- * creates <CODE>Name</CODE> objects with a local name, a
- * namespace prefix, and a namesapce URI. The second method
- * creates <CODE>Name</CODE> objects with a local name and a
- * namespace prefix, and the third creates <CODE>Name</CODE>
- * objects with just a local name. The following line of code, in
- * which <I>se</I> is a <CODE>SOAPEnvelope</CODE> object, creates
- * a new <CODE>Name</CODE> object with all three.</P>
+ * It is an error to add a <CODE>SOAPBody</CODE> or <CODE>
+ * SOAPHeader</CODE> object if one already exists.
+ * <p/>
+ * <P>The <CODE>SOAPEnvelope</CODE> interface provides three
+ * methods for creating <CODE>Name</CODE> objects. One method
+ * creates <CODE>Name</CODE> objects with a local name, a
+ * namespace prefix, and a namesapce URI. The second method
+ * creates <CODE>Name</CODE> objects with a local name and a
+ * namespace prefix, and the third creates <CODE>Name</CODE>
+ * objects with just a local name. The following line of code, in
+ * which <I>se</I> is a <CODE>SOAPEnvelope</CODE> object, creates
+ * a new <CODE>Name</CODE> object with all three.</P>
* <PRE>
- * Name name = se.createName("GetLastTradePrice", "WOMBAT",
- * "http://www.wombat.org/trader");
+ * Name name = se.createName("GetLastTradePrice", "WOMBAT",
+ * "http://www.wombat.org/trader");
* </PRE>
*/
public interface SOAPEnvelope extends SOAPElement {
/**
* Creates a new <CODE>Name</CODE> object initialized with the
- * given local name, namespace prefix, and namespace URI.
+ * given local name, namespace prefix, and namespace URI.
+ * <p/>
+ * <P>This factory method creates <CODE>Name</CODE> objects
+ * for use in the SOAP/XML document.
*
- * <P>This factory method creates <CODE>Name</CODE> objects
- * for use in the SOAP/XML document.
- * @param localName a <CODE>String</CODE> giving
- * the local name
- * @param prefix a <CODE>String</CODE> giving
- * the prefix of the namespace
- * @param uri a <CODE>String</CODE> giving the
- * URI of the namespace
+ * @param localName a <CODE>String</CODE> giving
+ * the local name
+ * @param prefix a <CODE>String</CODE> giving
+ * the prefix of the namespace
+ * @param uri a <CODE>String</CODE> giving the
+ * URI of the namespace
* @return a <CODE>Name</CODE> object initialized with the given
- * local name, namespace prefix, and namespace URI
- * @throws SOAPException if there is a SOAP error
+ * local name, namespace prefix, and namespace URI
+ * @throws SOAPException if there is a SOAP error
*/
public abstract Name createName(String localName, String prefix, String uri)
- throws SOAPException;
+ throws SOAPException;
/**
* Creates a new <CODE>Name</CODE> object initialized with the
- * given local name.
- *
- * <P>This factory method creates <CODE>Name</CODE> objects
- * for use in the SOAP/XML document.
+ * given local name.
+ * <p/>
+ * <P>This factory method creates <CODE>Name</CODE> objects
+ * for use in the SOAP/XML document.
*
* @param localName a <CODE>String</CODE> giving
- * the local name
+ * the local name
* @return a <CODE>Name</CODE> object initialized with the given
- * local name
- * @throws SOAPException if there is a SOAP error
+ * local name
+ * @throws SOAPException if there is a SOAP error
*/
public abstract Name createName(String localName) throws SOAPException;
/**
* Returns the <CODE>SOAPHeader</CODE> object for this <CODE>
- * SOAPEnvelope</CODE> object.
+ * SOAPEnvelope</CODE> object.
+ * <p/>
+ * <P>A new <CODE>SOAPMessage</CODE> object is by default
+ * created with a <CODE>SOAPEnvelope</CODE> object that
+ * contains an empty <CODE>SOAPHeader</CODE> object. As a
+ * result, the method <CODE>getHeader</CODE> will always
+ * return a <CODE>SOAPHeader</CODE> object unless the header
+ * has been removed and a new one has not been added.
*
- * <P>A new <CODE>SOAPMessage</CODE> object is by default
- * created with a <CODE>SOAPEnvelope</CODE> object that
- * contains an empty <CODE>SOAPHeader</CODE> object. As a
- * result, the method <CODE>getHeader</CODE> will always
- * return a <CODE>SOAPHeader</CODE> object unless the header
- * has been removed and a new one has not been added.
* @return the <CODE>SOAPHeader</CODE> object or <CODE>
- * null</CODE> if there is none
- * @throws SOAPException if there is a problem
- * obtaining the <CODE>SOAPHeader</CODE> object
+ * null</CODE> if there is none
+ * @throws SOAPException if there is a problem
+ * obtaining the <CODE>SOAPHeader</CODE> object
*/
public abstract SOAPHeader getHeader() throws SOAPException;
/**
* Returns the <CODE>SOAPBody</CODE> object associated with
- * this <CODE>SOAPEnvelope</CODE> object.
+ * this <CODE>SOAPEnvelope</CODE> object.
+ * <p/>
+ * <P>A new <CODE>SOAPMessage</CODE> object is by default
+ * created with a <CODE>SOAPEnvelope</CODE> object that
+ * contains an empty <CODE>SOAPBody</CODE> object. As a
+ * result, the method <CODE>getBody</CODE> will always return
+ * a <CODE>SOAPBody</CODE> object unless the body has been
+ * removed and a new one has not been added.
*
- * <P>A new <CODE>SOAPMessage</CODE> object is by default
- * created with a <CODE>SOAPEnvelope</CODE> object that
- * contains an empty <CODE>SOAPBody</CODE> object. As a
- * result, the method <CODE>getBody</CODE> will always return
- * a <CODE>SOAPBody</CODE> object unless the body has been
- * removed and a new one has not been added.
* @return the <CODE>SOAPBody</CODE> object for this <CODE>
- * SOAPEnvelope</CODE> object or <CODE>null</CODE> if there
- * is none
- * @throws SOAPException if there is a problem
- * obtaining the <CODE>SOAPBody</CODE> object
+ * SOAPEnvelope</CODE> object or <CODE>null</CODE> if there
+ * is none
+ * @throws SOAPException if there is a problem
+ * obtaining the <CODE>SOAPBody</CODE> object
*/
public abstract SOAPBody getBody() throws SOAPException;
/**
* Creates a <CODE>SOAPHeader</CODE> object and sets it as the
- * <CODE>SOAPHeader</CODE> object for this <CODE>
- * SOAPEnvelope</CODE> object.
+ * <CODE>SOAPHeader</CODE> object for this <CODE>
+ * SOAPEnvelope</CODE> object.
+ * <p/>
+ * <P>It is illegal to add a header when the envelope already
+ * contains a header. Therefore, this method should be called
+ * only after the existing header has been removed.
*
- * <P>It is illegal to add a header when the envelope already
- * contains a header. Therefore, this method should be called
- * only after the existing header has been removed.
* @return the new <CODE>SOAPHeader</CODE> object
- * @throws SOAPException if this <CODE>
- * SOAPEnvelope</CODE> object already contains a valid
- * <CODE>SOAPHeader</CODE> object
+ * @throws SOAPException if this <CODE>
+ * SOAPEnvelope</CODE> object already contains a valid
+ * <CODE>SOAPHeader</CODE> object
*/
public abstract SOAPHeader addHeader() throws SOAPException;
/**
* Creates a <CODE>SOAPBody</CODE> object and sets it as the
- * <CODE>SOAPBody</CODE> object for this <CODE>
- * SOAPEnvelope</CODE> object.
- *
- * <P>It is illegal to add a body when the envelope already
- * contains a body. Therefore, this method should be called
- * only after the existing body has been removed.
- * @return the new <CODE>SOAPBody</CODE> object
- * @throws SOAPException if this <CODE>
- * SOAPEnvelope</CODE> object already contains a valid
- * <CODE>SOAPBody</CODE> object
+ * <CODE>SOAPBody</CODE> object for this <CODE>
+ * SOAPEnvelope</CODE> object.
+ * <p/>
+ * <P>It is illegal to add a body when the envelope already
+ * contains a body. Therefore, this method should be called
+ * only after the existing body has been removed.
+ *
+ * @return the new <CODE>SOAPBody</CODE> object
+ * @throws SOAPException if this <CODE>
+ * SOAPEnvelope</CODE> object already contains a valid
+ * <CODE>SOAPBody</CODE> object
*/
public abstract SOAPBody addBody() throws SOAPException;
}
Modified: webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPException.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPException.java?rev=210150&r1=210149&r2=210150&view=diff
==============================================================================
--- webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPException.java (original)
+++ webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPException.java Mon Jul 11 08:49:30 2005
@@ -17,19 +17,19 @@
/**
* An exception that signals that a SOAP exception has
- * occurred. A <CODE>SOAPException</CODE> object may contain a
- * <CODE>String</CODE> that gives the reason for the exception, an
- * embedded <CODE>Throwable</CODE> object, or both. This class
- * provides methods for retrieving reason messages and for
- * retrieving the embedded <CODE>Throwable</CODE> object.</P>
- *
- * <P>Typical reasons for throwing a <CODE>SOAPException</CODE>
- * object are problems such as difficulty setting a header, not
- * being able to send a message, and not being able to get a
- * connection with the provider. Reasons for embedding a <CODE>
- * Throwable</CODE> object include problems such as input/output
- * errors or a parsing problem, such as an error in parsing a
- * header.
+ * occurred. A <CODE>SOAPException</CODE> object may contain a
+ * <CODE>String</CODE> that gives the reason for the exception, an
+ * embedded <CODE>Throwable</CODE> object, or both. This class
+ * provides methods for retrieving reason messages and for
+ * retrieving the embedded <CODE>Throwable</CODE> object.</P>
+ * <p/>
+ * <P>Typical reasons for throwing a <CODE>SOAPException</CODE>
+ * object are problems such as difficulty setting a header, not
+ * being able to send a message, and not being able to get a
+ * connection with the provider. Reasons for embedding a <CODE>
+ * Throwable</CODE> object include problems such as input/output
+ * errors or a parsing problem, such as an error in parsing a
+ * header.
*/
public class SOAPException extends Exception {
@@ -45,8 +45,9 @@
* Constructs a <CODE>SOAPException</CODE> object with the
* given <CODE>String</CODE> as the reason for the exception
* being thrown.
- * @param reason a description of what caused
- * the exception
+ *
+ * @param reason a description of what caused
+ * the exception
*/
public SOAPException(String reason) {
@@ -60,11 +61,12 @@
* given <CODE>String</CODE> as the reason for the exception
* being thrown and the given <CODE>Throwable</CODE> object as
* an embedded exception.
- * @param reason a description of what caused
- * the exception
- * @param cause a <CODE>Throwable</CODE> object
- * that is to be embedded in this <CODE>SOAPException</CODE>
- * object
+ *
+ * @param reason a description of what caused
+ * the exception
+ * @param cause a <CODE>Throwable</CODE> object
+ * that is to be embedded in this <CODE>SOAPException</CODE>
+ * object
*/
public SOAPException(String reason, Throwable cause) {
@@ -77,9 +79,10 @@
* Constructs a <CODE>SOAPException</CODE> object
* initialized with the given <CODE>Throwable</CODE>
* object.
- * @param cause a <CODE>Throwable</CODE> object
- * that is to be embedded in this <CODE>SOAPException</CODE>
- * object
+ *
+ * @param cause a <CODE>Throwable</CODE> object
+ * that is to be embedded in this <CODE>SOAPException</CODE>
+ * object
*/
public SOAPException(Throwable cause) {
@@ -90,17 +93,18 @@
/**
* Returns the detail message for this <CODE>
- * SOAPException</CODE> object.
+ * SOAPException</CODE> object.
+ * <p/>
+ * <P>If there is an embedded <CODE>Throwable</CODE> object,
+ * and if the <CODE>SOAPException</CODE> object has no detail
+ * message of its own, this method will return the detail
+ * message from the embedded <CODE>Throwable</CODE>
+ * object.</P>
*
- * <P>If there is an embedded <CODE>Throwable</CODE> object,
- * and if the <CODE>SOAPException</CODE> object has no detail
- * message of its own, this method will return the detail
- * message from the embedded <CODE>Throwable</CODE>
- * object.</P>
- * @return the error or warning message for this <CODE>
- * SOAPException</CODE> or, if it has none, the message of
- * the embedded <CODE>Throwable</CODE> object, if there is
- * one
+ * @return the error or warning message for this <CODE>
+ * SOAPException</CODE> or, if it has none, the message of
+ * the embedded <CODE>Throwable</CODE> object, if there is
+ * one
*/
public String getMessage() {
@@ -117,8 +121,9 @@
* Returns the <CODE>Throwable</CODE> object embedded in
* this <CODE>SOAPException</CODE> if there is one. Otherwise,
* this method returns <CODE>null</CODE>.
- * @return the embedded <CODE>Throwable</CODE> object or <CODE>
- * null</CODE> if there is none
+ *
+ * @return the embedded <CODE>Throwable</CODE> object or <CODE>
+ * null</CODE> if there is none
*/
public Throwable getCause() {
return cause;
@@ -126,37 +131,39 @@
/**
* Initializes the <CODE>cause</CODE> field of this <CODE>
- * SOAPException</CODE> object with the given <CODE>
- * Throwable</CODE> object.
+ * SOAPException</CODE> object with the given <CODE>
+ * Throwable</CODE> object.
+ * <p/>
+ * <P>This method can be called at most once. It is generally
+ * called from within the constructor or immediately after the
+ * constructor has returned a new <CODE>SOAPException</CODE>
+ * object. If this <CODE>SOAPException</CODE> object was
+ * created with the constructor {@link #SOAPException(java.lang.Throwable) SOAPException(java.lang.Throwable)}
+ * or {@link #SOAPException(java.lang.String, java.lang.Throwable) SOAPException(java.lang.String, java.lang.Throwable)}, meaning
+ * that its <CODE>cause</CODE> field already has a value, this
+ * method cannot be called even once.
*
- * <P>This method can be called at most once. It is generally
- * called from within the constructor or immediately after the
- * constructor has returned a new <CODE>SOAPException</CODE>
- * object. If this <CODE>SOAPException</CODE> object was
- * created with the constructor {@link #SOAPException(java.lang.Throwable) SOAPException(java.lang.Throwable)}
- * or {@link #SOAPException(java.lang.String, java.lang.Throwable) SOAPException(java.lang.String, java.lang.Throwable)}, meaning
- * that its <CODE>cause</CODE> field already has a value, this
- * method cannot be called even once.
- *
- * @param cause the <CODE>Throwable</CODE>
- * object that caused this <CODE>SOAPException</CODE> object
- * to be thrown. The value of this parameter is saved for
- * later retrieval by the <A href=
- * "../../../javax/xml/soap/SOAPException.html#getCause()">
- * <CODE>getCause()</CODE></A> method. A <TT>null</TT> value
- * is permitted and indicates that the cause is nonexistent
- * or unknown.
+ * @param cause the <CODE>Throwable</CODE>
+ * object that caused this <CODE>SOAPException</CODE> object
+ * to be thrown. The value of this parameter is saved for
+ * later retrieval by the <A href=
+ * "../../../javax/xml/soap/SOAPException.html#getCause()">
+ * <CODE>getCause()</CODE></A> method. A <TT>null</TT> value
+ * is permitted and indicates that the cause is nonexistent
+ * or unknown.
* @return a reference to this <CODE>SOAPException</CODE>
- * instance
- * @throws java.lang.IllegalArgumentException if
- * <CODE>cause</CODE> is this <CODE>Throwable</CODE> object.
- * (A <CODE>Throwable</CODE> object cannot be its own
- * cause.)
- * @throws java.lang.IllegalStateException if this <CODE>
- * SOAPException</CODE> object was created with {@link #SOAPException(java.lang.Throwable) SOAPException(java.lang.Throwable)}
- * or {@link #SOAPException(java.lang.String, java.lang.Throwable) SOAPException(java.lang.String, java.lang.Throwable)}, or this
- * method has already been called on this <CODE>
- * SOAPException</CODE> object
+ * instance
+ * @throws java.lang.IllegalArgumentException
+ * if
+ * <CODE>cause</CODE> is this <CODE>Throwable</CODE> object.
+ * (A <CODE>Throwable</CODE> object cannot be its own
+ * cause.)
+ * @throws java.lang.IllegalStateException
+ * if this <CODE>
+ * SOAPException</CODE> object was created with {@link #SOAPException(java.lang.Throwable) SOAPException(java.lang.Throwable)}
+ * or {@link #SOAPException(java.lang.String, java.lang.Throwable) SOAPException(java.lang.String, java.lang.Throwable)}, or this
+ * method has already been called on this <CODE>
+ * SOAPException</CODE> object
*/
public synchronized Throwable initCause(Throwable cause) {
Modified: webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPFactory.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPFactory.java?rev=210150&r1=210149&r2=210150&view=diff
==============================================================================
--- webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPFactory.java (original)
+++ webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPFactory.java Mon Jul 11 08:49:30 2005
@@ -18,32 +18,32 @@
/**
* <code>SOAPFactory</code> is a factory for creating various objects
* that exist in the SOAP XML tree.
- *
+ * <p/>
* <code>SOAPFactory</code> can be
* used to create XML fragments that will eventually end up in the
* SOAP part. These fragments can be inserted as children of the
* <code>SOAPHeaderElement</code> or <code>SOAPBodyElement</code> or
* <code>SOAPEnvelope</code>.
- *
+ * <p/>
* <code>SOAPFactory</code> also has methods to create
* <code>javax.xml.soap.Detail</code> objects as well as
* <code>java.xml.soap.Name</code> objects.
- *
*/
public abstract class SOAPFactory {
- public SOAPFactory() {}
+ public SOAPFactory() {
+ }
/**
* Create a <code>SOAPElement</code> object initialized with the
* given <code>Name</code> object.
*
* @param name a <code>Name</code> object with the XML name for
- * the new element
- * @return the new <code>SOAPElement</code> object that was
- * created
+ * the new element
+ * @return the new <code>SOAPElement</code> object that was
+ * created
* @throws SOAPException if there is an error in creating the
- * <code>SOAPElement</code> object
+ * <code>SOAPElement</code> object
*/
public abstract SOAPElement createElement(Name name) throws SOAPException;
@@ -52,11 +52,11 @@
* given local name.
*
* @param localName a <code>String</code> giving the local name for
- * the new element
+ * the new element
* @return the new <code>SOAPElement</code> object that was
- * created
+ * created
* @throws SOAPException if there is an error in creating the
- * <code>SOAPElement</code> object
+ * <code>SOAPElement</code> object
*/
public abstract SOAPElement createElement(String localName) throws SOAPException;
@@ -65,22 +65,22 @@
* local name, prefix and uri.
*
* @param localName a <code>String</code> giving the local name
- * for the new element
- * @param prefix the prefix for this <code>SOAPElement</code>
- * @param uri a <code>String</code> giving the URI of the
- * namespace to which the new element belongs
+ * for the new element
+ * @param prefix the prefix for this <code>SOAPElement</code>
+ * @param uri a <code>String</code> giving the URI of the
+ * namespace to which the new element belongs
* @return the new <code>SOAPElement</code> object that was
- * created
+ * created
* @throws SOAPException if there is an error in creating the
- * <code>SOAPElement</code> object
+ * <code>SOAPElement</code> object
*/
public abstract SOAPElement createElement(String localName, String prefix, String uri)
- throws SOAPException;
+ throws SOAPException;
/**
* Creates a new <code>Detail</code> object which serves as a container
* for <code>DetailEntry</code> objects.
- * <p>
+ * <p/>
* This factory method creates <code>Detail</code> objects for use in
* situations where it is not practical to use the <code>SOAPFault</code>
* abstraction.
@@ -93,32 +93,32 @@
/**
* Creates a new <code>Name</code> object initialized with the
* given local name, namespace prefix, and namespace URI.
- * <p>
+ * <p/>
* This factory method creates <code>Name</code> objects for use in
* situations where it is not practical to use the <code>SOAPEnvelope</code>
* abstraction.
*
* @param localName a <code>String</code> giving the local name
- * @param prefix a <code>String</code> giving the prefix of the namespace
- * @param uri a <code>String</code> giving the URI of the namespace
+ * @param prefix a <code>String</code> giving the prefix of the namespace
+ * @param uri a <code>String</code> giving the URI of the namespace
* @return a <code>Name</code> object initialized with the given
- * local name, namespace prefix, and namespace URI
+ * local name, namespace prefix, and namespace URI
* @throws SOAPException if there is a SOAP error
*/
public abstract Name createName(String localName, String prefix, String uri)
- throws SOAPException;
+ throws SOAPException;
/**
* Creates a new <code>Name</code> object initialized with the
* given local name.
- * <p>
+ * <p/>
* This factory method creates <code>Name</code> objects for use in
* situations where it is not practical to use the <code>SOAPEnvelope</code>
* abstraction.
*
* @param localName a <code>String</code> giving the local name
* @return a <code>Name</code> object initialized with the given
- * local name
+ * local name
* @throws SOAPException if there is a SOAP error
*/
public abstract Name createName(String localName) throws SOAPException;
@@ -128,7 +128,7 @@
*
* @return a new instance of a <code>SOAPFactory</code>
* @throws SOAPException if there was an error creating the
- * default <code>SOAPFactory</code>
+ * default <code>SOAPFactory</code>
*/
public static SOAPFactory newInstance() throws SOAPException {
@@ -143,5 +143,5 @@
private static final String SF_PROPERTY = "javax.xml.soap.SOAPFactory";
private static final String DEFAULT_SF =
- "org.apache.axis2.saaj.SOAPFactoryImpl";
+ "org.apache.axis2.saaj.SOAPFactoryImpl";
}
Modified: webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPFault.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPFault.java?rev=210150&r1=210149&r2=210150&view=diff
==============================================================================
--- webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPFault.java (original)
+++ webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPFault.java Mon Jul 11 08:49:30 2005
@@ -19,38 +19,39 @@
/**
* An element in the <CODE>SOAPBody</CODE> object that contains
- * error and/or status information. This information may relate to
- * errors in the <CODE>SOAPMessage</CODE> object or to problems
- * that are not related to the content in the message itself.
- * Problems not related to the message itself are generally errors
- * in processing, such as the inability to communicate with an
- * upstream server.
- * <P>
- * The <CODE>SOAPFault</CODE> interface provides methods for
- * retrieving the information contained in a <CODE>
- * SOAPFault</CODE> object and for setting the fault code, the
- * fault actor, and a string describing the fault. A fault code is
- * one of the codes defined in the SOAP 1.1 specification that
- * describe the fault. An actor is an intermediate recipient to
- * whom a message was routed. The message path may include one or
- * more actors, or, if no actors are specified, the message goes
- * only to the default actor, which is the final intended
- * recipient.
+ * error and/or status information. This information may relate to
+ * errors in the <CODE>SOAPMessage</CODE> object or to problems
+ * that are not related to the content in the message itself.
+ * Problems not related to the message itself are generally errors
+ * in processing, such as the inability to communicate with an
+ * upstream server.
+ * <P>
+ * The <CODE>SOAPFault</CODE> interface provides methods for
+ * retrieving the information contained in a <CODE>
+ * SOAPFault</CODE> object and for setting the fault code, the
+ * fault actor, and a string describing the fault. A fault code is
+ * one of the codes defined in the SOAP 1.1 specification that
+ * describe the fault. An actor is an intermediate recipient to
+ * whom a message was routed. The message path may include one or
+ * more actors, or, if no actors are specified, the message goes
+ * only to the default actor, which is the final intended
+ * recipient.
*/
public interface SOAPFault extends SOAPBodyElement {
/**
* Sets this <CODE>SOAPFault</CODE> object with the given
- * fault code.
- *
- * <P>Fault codes, which given information about the fault,
- * are defined in the SOAP 1.1 specification.</P>
- * @param faultCode a <CODE>String</CODE> giving
- * the fault code to be set; must be one of the fault codes
- * defined in the SOAP 1.1 specification
- * @throws SOAPException if there was an error in
- * adding the <CODE>faultCode</CODE> to the underlying XML
- * tree.
+ * fault code.
+ * <p/>
+ * <P>Fault codes, which given information about the fault,
+ * are defined in the SOAP 1.1 specification.</P>
+ *
+ * @param faultCode a <CODE>String</CODE> giving
+ * the fault code to be set; must be one of the fault codes
+ * defined in the SOAP 1.1 specification
+ * @throws SOAPException if there was an error in
+ * adding the <CODE>faultCode</CODE> to the underlying XML
+ * tree.
* @see #getFaultCode() getFaultCode()
*/
public abstract void setFaultCode(String faultCode) throws SOAPException;
@@ -58,23 +59,25 @@
/**
* Gets the fault code for this <CODE>SOAPFault</CODE>
* object.
+ *
* @return a <CODE>String</CODE> with the fault code
* @see #setFaultCode(java.lang.String) setFaultCode(java.lang.String)
*/
public abstract String getFaultCode();
/**
- * Sets this <CODE>SOAPFault</CODE> object with the given
- * fault actor.
- *
- * <P>The fault actor is the recipient in the message path who
- * caused the fault to happen.</P>
- * @param faultActor a <CODE>String</CODE>
- * identifying the actor that caused this <CODE>
- * SOAPFault</CODE> object
- * @throws SOAPException if there was an error in
- * adding the <CODE>faultActor</CODE> to the underlying XML
- * tree.
+ * Sets this <CODE>SOAPFault</CODE> object with the given
+ * fault actor.
+ * <p/>
+ * <P>The fault actor is the recipient in the message path who
+ * caused the fault to happen.</P>
+ *
+ * @param faultActor a <CODE>String</CODE>
+ * identifying the actor that caused this <CODE>
+ * SOAPFault</CODE> object
+ * @throws SOAPException if there was an error in
+ * adding the <CODE>faultActor</CODE> to the underlying XML
+ * tree.
* @see #getFaultActor() getFaultActor()
*/
public abstract void setFaultActor(String faultActor) throws SOAPException;
@@ -82,8 +85,9 @@
/**
* Gets the fault actor for this <CODE>SOAPFault</CODE>
* object.
- * @return a <CODE>String</CODE> giving the actor in the message
- * path that caused this <CODE>SOAPFault</CODE> object
+ *
+ * @return a <CODE>String</CODE> giving the actor in the message
+ * path that caused this <CODE>SOAPFault</CODE> object
* @see #setFaultActor(java.lang.String) setFaultActor(java.lang.String)
*/
public abstract String getFaultActor();
@@ -93,74 +97,77 @@
* object to the given string.
*
* @param faultString a <CODE>String</CODE>
- * giving an explanation of the fault
- * @throws SOAPException if there was an error in
- * adding the <CODE>faultString</CODE> to the underlying XML
- * tree.
+ * giving an explanation of the fault
+ * @throws SOAPException if there was an error in
+ * adding the <CODE>faultString</CODE> to the underlying XML
+ * tree.
* @see #getFaultString() getFaultString()
*/
public abstract void setFaultString(String faultString)
- throws SOAPException;
+ throws SOAPException;
/**
* Gets the fault string for this <CODE>SOAPFault</CODE>
* object.
+ *
* @return a <CODE>String</CODE> giving an explanation of the
- * fault
+ * fault
*/
public abstract String getFaultString();
/**
* Returns the detail element for this <CODE>SOAPFault</CODE>
- * object.
+ * object.
+ * <p/>
+ * <P>A <CODE>Detail</CODE> object carries
+ * application-specific error information related to <CODE>
+ * SOAPBodyElement</CODE> objects.</P>
*
- * <P>A <CODE>Detail</CODE> object carries
- * application-specific error information related to <CODE>
- * SOAPBodyElement</CODE> objects.</P>
- * @return a <CODE>Detail</CODE> object with
- * application-specific error information
+ * @return a <CODE>Detail</CODE> object with
+ * application-specific error information
*/
public abstract Detail getDetail();
/**
* Creates a <CODE>Detail</CODE> object and sets it as the
- * <CODE>Detail</CODE> object for this <CODE>SOAPFault</CODE>
- * object.
+ * <CODE>Detail</CODE> object for this <CODE>SOAPFault</CODE>
+ * object.
+ * <p/>
+ * <P>It is illegal to add a detail when the fault already
+ * contains a detail. Therefore, this method should be called
+ * only after the existing detail has been removed.</P>
*
- * <P>It is illegal to add a detail when the fault already
- * contains a detail. Therefore, this method should be called
- * only after the existing detail has been removed.</P>
* @return the new <CODE>Detail</CODE> object
- * @throws SOAPException if this
- * <CODE>SOAPFault</CODE> object already contains a valid
- * <CODE>Detail</CODE> object
+ * @throws SOAPException if this
+ * <CODE>SOAPFault</CODE> object already contains a valid
+ * <CODE>Detail</CODE> object
*/
public abstract Detail addDetail() throws SOAPException;
/**
* Sets this <code>SOAPFault</code> object with the given fault code.
- *
+ * <p/>
* Fault codes, which give information about the fault, are defined in the
* SOAP 1.1 specification. A fault code is mandatory and must be of type
* <code>QName</code>. This method provides a convenient way to set a fault
* code. For example,
- *
+ * <p/>
* <pre>
- SOAPEnvelope se = ...;
- // Create a qualified name in the SOAP namespace with a localName
- // of "Client". Note that prefix parameter is optional and is null
- // here which causes the implementation to use an appropriate prefix.
- Name qname = se.createName("Client", null,
- SOAPConstants.URI_NS_SOAP_ENVELOPE);
- SOAPFault fault = ...;
- fault.setFaultCode(qname);
- *
+ * SOAPEnvelope se = ...;
+ * // Create a qualified name in the SOAP namespace with a localName
+ * // of "Client". Note that prefix parameter is optional and is null
+ * // here which causes the implementation to use an appropriate prefix.
+ * Name qname = se.createName("Client", null,
+ * SOAPConstants.URI_NS_SOAP_ENVELOPE);
+ * SOAPFault fault = ...;
+ * fault.setFaultCode(qname);
+ * <p/>
* It is preferable to use this method over setFaultCode(String).
*
* @param name a <code>Name</code> object giving the fault code to be set.
- * It must be namespace qualified.
+ * It must be namespace qualified.
* @throws SOAPException if there was an error in adding the
- * <code>faultcode</code> element to the underlying XML tree
+ * <code>faultcode</code> element to the underlying XML tree
*/
public abstract void setFaultCode(Name name) throws SOAPException;
@@ -172,8 +179,9 @@
* SAAJ <code>Name</code> object. This method should be used instead of the
* <code>getFaultCode()</code> method since it allows applications to easily
* access the namespace name without additional parsing.
- * <p>
+ * <p/>
* In the future, a QName object version of this method may also be added.
+ *
* @return a <code>Name</code> representing the faultcode
*/
public abstract Name getFaultCodeAsName();
@@ -182,12 +190,12 @@
* Sets the fault string for this <code>SOAPFault</code> object to the given
* string and localized to the given locale.
*
- * @param faultString a <code>String</code> giving an explanation of
- * the fault
- * @param locale a <code>Locale</code> object indicating the
- * native language of the <code>faultString</code>
- * @throws SOAPException if there was an error in adding the
- * <code>faultString</code> to the underlying XML tree
+ * @param faultString a <code>String</code> giving an explanation of
+ * the fault
+ * @param locale a <code>Locale</code> object indicating the
+ * native language of the <code>faultString</code>
+ * @throws SOAPException if there was an error in adding the
+ * <code>faultString</code> to the underlying XML tree
*/
public abstract void setFaultString(String faultString, Locale locale) throws SOAPException;
@@ -196,8 +204,8 @@
* object.
*
* @return a <code>Locale</code> object indicating the native language of
- * the fault string or <code>null</code> if no locale was
- * specified
+ * the fault string or <code>null</code> if no locale was
+ * specified
*/
public abstract Locale getFaultStringLocale();
}
Modified: webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPFaultElement.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPFaultElement.java?rev=210150&r1=210149&r2=210150&view=diff
==============================================================================
--- webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPFaultElement.java (original)
+++ webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPFaultElement.java Mon Jul 11 08:49:30 2005
@@ -19,8 +19,9 @@
* A representation of the contents in
* a <code>SOAPFault</code> object. The <code>Detail</code> interface
* is a <code>SOAPFaultElement</code> object that has been defined.
- * <p>
+ * <p/>
* Content is added to a <code>SOAPFaultElement</code> using the
* <code>SOAPElement</code> method <code>addTextNode</code>.
*/
-public interface SOAPFaultElement extends SOAPElement {}
+public interface SOAPFaultElement extends SOAPElement {
+}
Modified: webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPHeader.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPHeader.java?rev=210150&r1=210149&r2=210150&view=diff
==============================================================================
--- webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPHeader.java (original)
+++ webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPHeader.java Mon Jul 11 08:49:30 2005
@@ -19,41 +19,42 @@
/**
* <P>A representation of the SOAP header element. A SOAP header
- * element consists of XML data that affects the way the
- * application-specific content is processed by the message
- * provider. For example, transaction semantics, authentication
- * information, and so on, can be specified as the content of a
- * <CODE>SOAPHeader</CODE> object.</P>
- *
- * <P>A <CODE>SOAPEnvelope</CODE> object contains an empty <CODE>
- * SOAPHeader</CODE> object by default. If the <CODE>
- * SOAPHeader</CODE> object, which is optional, is not needed, it
- * can be retrieved and deleted with the following line of code.
- * The variable <I>se</I> is a <CODE>SOAPEnvelope</CODE>
- * object.</P>
+ * element consists of XML data that affects the way the
+ * application-specific content is processed by the message
+ * provider. For example, transaction semantics, authentication
+ * information, and so on, can be specified as the content of a
+ * <CODE>SOAPHeader</CODE> object.</P>
+ * <p/>
+ * <P>A <CODE>SOAPEnvelope</CODE> object contains an empty <CODE>
+ * SOAPHeader</CODE> object by default. If the <CODE>
+ * SOAPHeader</CODE> object, which is optional, is not needed, it
+ * can be retrieved and deleted with the following line of code.
+ * The variable <I>se</I> is a <CODE>SOAPEnvelope</CODE>
+ * object.</P>
* <PRE>
- * se.getHeader().detachNode();
+ * se.getHeader().detachNode();
* </PRE>
- * A <CODE>SOAPHeader</CODE> object is created with the <CODE>
- * SOAPEnvelope</CODE> method <CODE>addHeader</CODE>. This method,
- * which creates a new header and adds it to the envelope, may be
- * called only after the existing header has been removed.
+ * A <CODE>SOAPHeader</CODE> object is created with the <CODE>
+ * SOAPEnvelope</CODE> method <CODE>addHeader</CODE>. This method,
+ * which creates a new header and adds it to the envelope, may be
+ * called only after the existing header has been removed.
* <PRE>
- * se.getHeader().detachNode();
- * SOAPHeader sh = se.addHeader();
+ * se.getHeader().detachNode();
+ * SOAPHeader sh = se.addHeader();
* </PRE>
- *
- * <P>A <CODE>SOAPHeader</CODE> object can have only <CODE>
- * SOAPHeaderElement</CODE> objects as its immediate children. The
- * method <CODE>addHeaderElement</CODE> creates a new <CODE>
- * HeaderElement</CODE> object and adds it to the <CODE>
- * SOAPHeader</CODE> object. In the following line of code, the
- * argument to the method <CODE>addHeaderElement</CODE> is a
- * <CODE>Name</CODE> object that is the name for the new <CODE>
- * HeaderElement</CODE> object.</P>
+ * <p/>
+ * <P>A <CODE>SOAPHeader</CODE> object can have only <CODE>
+ * SOAPHeaderElement</CODE> objects as its immediate children. The
+ * method <CODE>addHeaderElement</CODE> creates a new <CODE>
+ * HeaderElement</CODE> object and adds it to the <CODE>
+ * SOAPHeader</CODE> object. In the following line of code, the
+ * argument to the method <CODE>addHeaderElement</CODE> is a
+ * <CODE>Name</CODE> object that is the name for the new <CODE>
+ * HeaderElement</CODE> object.</P>
* <PRE>
- * SOAPHeaderElement shElement = sh.addHeaderElement(name);
+ * SOAPHeaderElement shElement = sh.addHeaderElement(name);
* </PRE>
+ *
* @see SOAPHeaderElement SOAPHeaderElement
*/
public interface SOAPHeader extends SOAPElement {
@@ -62,16 +63,17 @@
* Creates a new <CODE>SOAPHeaderElement</CODE> object
* initialized with the specified name and adds it to this
* <CODE>SOAPHeader</CODE> object.
- * @param name a <CODE>Name</CODE> object with
- * the name of the new <CODE>SOAPHeaderElement</CODE>
- * object
+ *
+ * @param name a <CODE>Name</CODE> object with
+ * the name of the new <CODE>SOAPHeaderElement</CODE>
+ * object
* @return the new <CODE>SOAPHeaderElement</CODE> object that
- * was inserted into this <CODE>SOAPHeader</CODE>
- * object
- * @throws SOAPException if a SOAP error occurs
+ * was inserted into this <CODE>SOAPHeader</CODE>
+ * object
+ * @throws SOAPException if a SOAP error occurs
*/
public abstract SOAPHeaderElement addHeaderElement(Name name)
- throws SOAPException;
+ throws SOAPException;
/**
* Returns a list of all the <CODE>SOAPHeaderElement</CODE>
@@ -83,30 +85,32 @@
* recipient for the message, so if no actor attribute is
* included in a <CODE>SOAPHeader</CODE> object, the message is
* sent to its ultimate destination.
- * @param actor a <CODE>String</CODE> giving the
- * URI of the actor for which to search
+ *
+ * @param actor a <CODE>String</CODE> giving the
+ * URI of the actor for which to search
* @return an <CODE>Iterator</CODE> object over all the <CODE>
- * SOAPHeaderElement</CODE> objects that contain the
- * specified actor
+ * SOAPHeaderElement</CODE> objects that contain the
+ * specified actor
* @see #extractHeaderElements(java.lang.String) extractHeaderElements(java.lang.String)
*/
public abstract Iterator examineHeaderElements(String actor);
/**
* Returns a list of all the <CODE>SOAPHeaderElement</CODE>
- * objects in this <CODE>SOAPHeader</CODE> object that have
- * the the specified actor and detaches them from this <CODE>
- * SOAPHeader</CODE> object.
- *
- * <P>This method allows an actor to process only the parts of
- * the <CODE>SOAPHeader</CODE> object that apply to it and to
- * remove them before passing the message on to the next
- * actor.
- * @param actor a <CODE>String</CODE> giving the
- * URI of the actor for which to search
+ * objects in this <CODE>SOAPHeader</CODE> object that have
+ * the the specified actor and detaches them from this <CODE>
+ * SOAPHeader</CODE> object.
+ * <p/>
+ * <P>This method allows an actor to process only the parts of
+ * the <CODE>SOAPHeader</CODE> object that apply to it and to
+ * remove them before passing the message on to the next
+ * actor.
+ *
+ * @param actor a <CODE>String</CODE> giving the
+ * URI of the actor for which to search
* @return an <CODE>Iterator</CODE> object over all the <CODE>
- * SOAPHeaderElement</CODE> objects that contain the
- * specified actor
+ * SOAPHeaderElement</CODE> objects that contain the
+ * specified actor
* @see #examineHeaderElements(java.lang.String) examineHeaderElements(java.lang.String)
*/
public abstract Iterator extractHeaderElements(String actor);
@@ -120,8 +124,8 @@
* @param actor a <code>String</code> giving the URI of the actor for which
* to search
* @return an <code>Iterator</code> object over all the
- * <code>SOAPHeaderElement</code> objects that contain the
- * specified actor and are marked as MustUnderstand
+ * <code>SOAPHeaderElement</code> objects that contain the
+ * specified actor and are marked as MustUnderstand
*/
public abstract Iterator examineMustUnderstandHeaderElements(String actor);
@@ -131,8 +135,8 @@
* object.
*
* @return an <code>Iterator</code> object over all the
- * <code>SOAPHeaderElement</code> objects contained by this
- * <code>SOAPHeader</code>
+ * <code>SOAPHeaderElement</code> objects contained by this
+ * <code>SOAPHeader</code>
*/
public abstract Iterator examineAllHeaderElements();
@@ -142,8 +146,8 @@
* object and detaches them from this <code>SOAPHeader</code> object.
*
* @return an <code>Iterator</code> object over all the
- * <code>SOAPHeaderElement</code> objects contained by this
- * <code>SOAPHeader</code>
+ * <code>SOAPHeaderElement</code> objects contained by this
+ * <code>SOAPHeader</code>
*/
public abstract Iterator extractAllHeaderElements();
}
Modified: webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPHeaderElement.java
URL: http://svn.apache.org/viewcvs/webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPHeaderElement.java?rev=210150&r1=210149&r2=210150&view=diff
==============================================================================
--- webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPHeaderElement.java (original)
+++ webservices/axis/trunk/java/modules/saaj/src/javax/xml/soap/SOAPHeaderElement.java Mon Jul 11 08:49:30 2005
@@ -16,13 +16,13 @@
package javax.xml.soap;
/**
- * <P>An object representing the contents in the SOAP header part
- * of the SOAP envelope. The immediate children of a <CODE>
- * SOAPHeader</CODE> object can be represented only as <CODE>
- * SOAPHeaderElement</CODE> objects.</P>
- *
- * <P>A <CODE>SOAPHeaderElement</CODE> object can have other
- * <CODE>SOAPElement</CODE> objects as its children.</P>
+ * <P>An object representing the contents in the SOAP header part
+ * of the SOAP envelope. The immediate children of a <CODE>
+ * SOAPHeader</CODE> object can be represented only as <CODE>
+ * SOAPHeaderElement</CODE> objects.</P>
+ * <p/>
+ * <P>A <CODE>SOAPHeaderElement</CODE> object can have other
+ * <CODE>SOAPElement</CODE> objects as its children.</P>
*/
public interface SOAPHeaderElement extends SOAPElement {
@@ -31,37 +31,42 @@
* SOAPHeaderElement</CODE> object to the specified actor. The
* default value of an actor is: <CODE>
* SOAPConstants.URI_SOAP_ACTOR_NEXT</CODE>
- * @param actorURI a <CODE>String</CODE> giving
- * the URI of the actor to set
+ *
+ * @param actorURI a <CODE>String</CODE> giving
+ * the URI of the actor to set
+ * @throws java.lang.IllegalArgumentException
+ * if
+ * there is a problem in setting the actor.
* @see #getActor() getActor()
- * @throws java.lang.IllegalArgumentException if
- * there is a problem in setting the actor.
*/
public abstract void setActor(String actorURI);
/**
* Returns the uri of the actor associated with this <CODE>
* SOAPHeaderElement</CODE> object.
- * @return a <CODE>String</CODE> giving the URI of the
- * actor
+ *
+ * @return a <CODE>String</CODE> giving the URI of the
+ * actor
* @see #setActor(java.lang.String) setActor(java.lang.String)
*/
public abstract String getActor();
/**
* Sets the mustUnderstand attribute for this <CODE>
- * SOAPHeaderElement</CODE> object to be on or off.
+ * SOAPHeaderElement</CODE> object to be on or off.
+ * <p/>
+ * <P>If the mustUnderstand attribute is on, the actor who
+ * receives the <CODE>SOAPHeaderElement</CODE> must process it
+ * correctly. This ensures, for example, that if the <CODE>
+ * SOAPHeaderElement</CODE> object modifies the message, that
+ * the message is being modified correctly.</P>
*
- * <P>If the mustUnderstand attribute is on, the actor who
- * receives the <CODE>SOAPHeaderElement</CODE> must process it
- * correctly. This ensures, for example, that if the <CODE>
- * SOAPHeaderElement</CODE> object modifies the message, that
- * the message is being modified correctly.</P>
- * @param mustUnderstand <CODE>true</CODE> to
- * set the mustUnderstand attribute on; <CODE>false</CODE>
- * to turn if off
- * @throws java.lang.IllegalArgumentException if
- * there is a problem in setting the actor.
+ * @param mustUnderstand <CODE>true</CODE> to
+ * set the mustUnderstand attribute on; <CODE>false</CODE>
+ * to turn if off
+ * @throws java.lang.IllegalArgumentException
+ * if
+ * there is a problem in setting the actor.
* @see #getMustUnderstand() getMustUnderstand()
*/
public abstract void setMustUnderstand(boolean mustUnderstand);
@@ -69,9 +74,10 @@
/**
* Returns whether the mustUnderstand attribute for this
* <CODE>SOAPHeaderElement</CODE> object is turned on.
- * @return <CODE>true</CODE> if the mustUnderstand attribute of
- * this <CODE>SOAPHeaderElement</CODE> object is turned on;
- * <CODE>false</CODE> otherwise
+ *
+ * @return <CODE>true</CODE> if the mustUnderstand attribute of
+ * this <CODE>SOAPHeaderElement</CODE> object is turned on;
+ * <CODE>false</CODE> otherwise
*/
public abstract boolean getMustUnderstand();
}