| Home >> All >> org >> apache >> xmlbeans >> impl >> [ soap Javadoc ] |
• org.apache.xmlbeans.impl.soap: Javadoc index of package org.apache.xmlbeans.impl.soap.
Package Samples:
• org.apache.xmlbeans.impl.soap
Classes:
• AttachmentPart: A single attachment to a SOAPMessage object. A SOAPMessage object may contain zero, one, or many AttachmentPart objects. Each AttachmentPart object consists of two parts, application-specific content and associated MIME headers. The MIME headers consists of name/value pairs that can be used to identify and describe the content. An AttachmentPart object must conform to certain standards. It must conform to MIME [RFC2045] standards It MUST contain content The header portion MUST include the following header: Content-Type This header identifies the type of data in the content of an AttachmentPart ...
• SOAPEnvelope: The container for the SOAPHeader and SOAPBody portions of a SOAPPart object. By default, a SOAPMessage object is created with a SOAPPart object that has a SOAPEnvelope object. The SOAPEnvelope object by default has an empty SOAPBody object and an empty SOAPHeader object. The SOAPBody object is required, and the SOAPHeader object, though optional, is used in the majority of cases. If the SOAPHeader object is not needed, it can be deleted, which is shown later. A client can access the SOAPHeader and SOAPBody objects by calling the methods SOAPEnvelope.getHeader and SOAPEnvelope.getBody . The following ...
• MessageFactory: A factory for creating SOAPMessage objects. A JAXM client performs the following steps to create a message. Creates a MessageFactory object from a ProviderConnection object ( con in the following line of code). The String passed to the createMessageFactory method is the name of of a messaging profile, which must be the URL for the schema. MessageFactory mf = con.createMessageFactory(schemaURL); Calls the method createMessage on the MessageFactory object. All messages produced by this MessageFactory object will have the header information appropriate for the messaging profile that was specified ...
• SOAPMessage: The root class for all SOAP messages. As transmitted on the "wire", a SOAP message is an XML document or a MIME message whose first body part is an XML/SOAP document. A SOAPMessage object consists of a SOAP part and optionally one or more attachment parts. The SOAP part for a SOAPMessage object is a SOAPPart object, which contains information used for message routing and identification, and which can contain application-specific content. All data in the SOAP Part of a message must be in XML format. A new SOAPMessage object contains the following by default: A SOAPPart object A SOAPEnvelope object ...
• Name: A representation of an XML name. This interface provides methods for getting the local and namespace-qualified names and also for getting the prefix associated with the namespace for the name. It is also possible to get the URI of the namespace. The following is an example of a namespace declaration in an element. <wombat:GetLastTradePrice xmlns:wombat="http://www.wombat.org/trader"> ("xmlns" stands for "XML namespace".) The following shows what the methods in the Name interface will return. getQualifiedName will return "prefix:LocalName" = "WOMBAT:GetLastTradePrice" getURI will return "http://www.wombat.org/trader" ...
• SOAPPart: The container for the SOAP-specific portion of a SOAPMessage object. All messages are required to have a SOAP part, so when a SOAPMessage object is created, it will automatically have a SOAPPart object. A SOAPPart object is a MIME part and has the MIME headers Content-Id, Content-Location, and Content-Type. Because the value of Content-Type must be "text/xml", a SOAPPart object automatically has a MIME header of Content-Type with its value set to "text/xml". The value must be "text/xml" because content in the SOAP part of a message must be in XML format. Content that is not of type "text/xml" must ...
• SOAPHeader: 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 SOAPHeader object. A SOAPEnvelope object contains an empty SOAPHeader object by default. If the SOAPHeader object, which is optional, is not needed, it can be retrieved and deleted with the following line of code. The variable se is a SOAPEnvelope object. se.getHeader().detachNode(); A SOAPHeader object is created ...
• Detail: A container for DetailEntry objects. DetailEntry objects give detailed error information that is application-specific and related to the SOAPBody object that contains it. A Detail object, which is part of a SOAPFault object, can be retrieved using the method SOAPFault.getDetail . The Detail interface provides two methods. One creates a new DetailEntry object and also automatically adds it to the Detail object. The second method gets a list of the DetailEntry objects contained in a Detail object. The following code fragment, in which sf is a SOAPFault object, gets its Detail object ( d ), adds a ...
• SOAPFault: An element in the SOAPBody object that contains error and/or status information. This information may relate to errors in the SOAPMessage 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. The SOAPFault interface provides methods for retrieving the information contained in a SOAPFault 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 ...
• SOAPException: An exception that signals that a SOAP exception has occurred. A SOAPException object may contain a String that gives the reason for the exception, an embedded Throwable object, or both. This class provides methods for retrieving reason messages and for retrieving the embedded Throwable object. Typical reasons for throwing a SOAPException 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 Throwable object include problems such as input/output errors or a parsing problem, such ...
• SOAPBodyElement: A SOAPBodyElement object represents the contents in a SOAPBody object. The SOAPFault interface is a SOAPBodyElement object that has been defined. A new SOAPBodyElement object can be created and added to a SOAPBody object with the SOAPBody method addBodyElement . In the following line of code, sb is a SOAPBody object, and myName is a Name object. SOAPBodyElement sbe = sb.addBodyElement(myName);
• SOAPConnection: A point-to-point connection that a client can use for sending messages directly to a remote party (represented by a URL, for instance). A client can obtain a SOAPConnection object simply by calling the following static method. SOAPConnection con = SOAPConnection.newInstance(); A SOAPConnection object can be used to send messages directly to a URL following the request/response paradigm. That is, messages are sent using the method call , which sends the message and then waits until it gets a reply.
• SOAPFactory: SOAPFactory is a factory for creating various objects that exist in the SOAP XML tree. SOAPFactory 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 SOAPHeaderElement or SOAPBodyElement or SOAPEnvelope . SOAPFactory also has methods to create javax.xml.soap.Detail objects as well as java.xml.soap.Name objects.
• SOAPConnectionFactory: A factory for creating SOAPConnection objects. Implementation of this class is optional. If SOAPConnectionFactory.newInstance() throws an UnsupportedOperationException then the implementation does not support the SAAJ communication infrastructure. Otherwise SOAPConnection objects can be created by calling createConnection() on the newly created SOAPConnectionFactory object.
• SOAPElementFactory: SOAPElementFactory is a factory for XML fragments that will eventually end up in the SOAP part. These fragments can be inserted as children of the SOAPHeader or SOAPBody or SOAPEnvelope . 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.
• SOAPBody: An object that represents the contents of the SOAP body element in a SOAP message. A SOAP body element consists of XML data that affects the way the application-specific content is processed. A SOAPBody object contains SOAPBodyElement objects, which have the content for the SOAP body. A SOAPFault object, which carries status and/or error information, is an example of a SOAPBodyElement object.
• SOAPElement: An object representing the contents in a SOAPBody object, the contents in a SOAPHeader object, the content that can follow the SOAPBody object in a SOAPEnvelope object, or what can follow the detail element in a SOAPFault object. It is the base class for all of the classes that represent the SOAP objects as defined in the SOAP specification.
• MimeHeaders: A container for MimeHeader objects, which represent the MIME headers present in a MIME part of a message. This class is used primarily when an application wants to retrieve specific attachments based on certain MIME headers and values. This class will most likely be used by implementations of AttachmentPart and other MIME dependent parts of the JAXM API.
• SOAPHeaderElement: An object representing the contents in the SOAP header part of the SOAP envelope. The immediate children of a SOAPHeader object can be represented only as SOAPHeaderElement objects. A SOAPHeaderElement object can have other SOAPElement objects as its children.
• SOAPFaultElement: A representation of the contents in a SOAPFault object. The Detail interface is a SOAPFaultElement object that has been defined. Content is added to a SOAPFaultElement using the SOAPElement method addTextNode .
• DetailEntry: The content for a Detail object, giving details for a SOAPFault object. A DetailEntry object, which carries information about errors related to the SOAPBody object that contains it, is application-specific.
• Node: A representation of a node (element) in a DOM representation of an XML document that provides some tree manipulation methods. This interface provides methods for getting the value of a node, for getting and setting the parent of a node, and for removing a node.
• FactoryFinder: This class is used to locate factory classes for javax.xml.soap. It has package scope since it is not part of JAXM and should not be accessed from other packages.
• MimeHeader: An object that stores a MIME header name and its value. One or more MimeHeader objects may be contained in a MimeHeaders object.
• Text: A representation of a node whose value is text. A Text object may represent text that is content or text that is a comment.
| Home | Contact Us | Privacy Policy | Terms of Service |