The JAXM Packages

printer-friendly version of this section  Print  e-mail this section  E-Mail  add a public, group or private note  Add Note  add a bookmark about this section  Add Bookmark    

Java APIs for XML Kick Start
By Aoyon Chowdhury, Parag Choudhary

Table of Contents
Chapter 7.  Messaging Fundamentals


JAXM is available in two packages:

  • javax.xml.messging

  • javax.xml.soap

The javax.xml.messaging Package

The javax.xml.messaging package provides the classes and interfaces required by JAXM clients to do one-way asynchronous messaging. This package works with the javax.xml.soap package.

The javax.xml.messaging package contains four interfaces, four classes, and one exception.

The javax.xml.messaging Interfaces

The javax.xml.messaging package contains the following interfaces:

  • OnewayListener This interface provides support for services or components, such as servlets, that are implemented to process asynchronous messages.

  • ProviderConnection This interface represents a JAXM client's active connection to its messaging provider.

  • ProviderMetaData This interface provides information about the messaging provider to which the client is connected.

  • ReqRespListener This interface provides support for components that process request-response messages.

The javax.xml.messaging Classes

The javax.xml.messaging package contains the following classes:

  • Endpoint This class represents the endpoint for a JAXM client.

  • JAXMServlet This is a superclass for components stored in a servlet container that receives JAXM messages.

  • ProviderConnectionFactory This is a factory class for creating connections to a particular messaging provider.

  • UrlEndpoint This class is a subclass of the Endpoint class, and is used by standalone JAXM clients.

The javax.xml.messaging Exception

The javax.xml.messaging package has the following exception:

  • JAXMException This exception is raised when a JAXM exception occurs. A JAXM exception occurs in situations such as the inability to send a message, or the inability to get a connection with the provider.

The javax.xml.soap Package

The javax.xml.soap package contains the APIs that enable an application to create SOAP messages. This package contains 14 interfaces, 9 classes, and 1 exception, described in the following sections.

The javax.xml.soap Interfaces

The javax.xml.soap package has the following interfaces:

  • Detail This interface is a container for DetailEntry objects. DetailEntry objects give detailed error information that is application-specific and related to the SOAPBody object that contains it.

  • DetailEntry This interface provides the content for a Detail object, providing details for a SOAPFault object. A DetailEntry object is application-specific and contains information about errors related to the SOAPBody object that contains it.

  • Name This interface is a representation of an XML name. It provides methods for getting the local and namespace-qualified names, as well as for getting the prefix associated with the namespace for the name. It is also possible to get the URI of the namespace.

  • Node This interface is a representation of a node element in a DOM representation of an XML document. It provides methods for getting and setting the parent of a node element and for removing a node.

  • SOAPBody This interface represents an object that represents the contents of the SOAPBody element in a SOAP message.

  • SOAPBodyElement This interface represents an object that represents the contents in a SOAPBody object.

  • SOAPConstants This interface contains the definitions of constants pertaining to the SOAP 1.1 protocol.

  • SOAPElement This interface represents an object that represents the contents in the 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.

  • SOAPEnvelope This interface represents the object that is the container for the SOAPHeader and SOAPBody portions of a SOAPPart object.

  • SOAPFault This interface represents an element in the SOAPBody object that contains error or status information.

  • SOAPFaultElement This interface represents the contents in a SOAPFault object.

  • SOAPHeader This interface represents the SOAP header element.

  • SOAPHeaderElement This interface represents an object that represents the contents in the SOAP header part of the SOAP envelope.

  • Text This interface represents a node whose value is text.

The javax.xml.soap Classes

The javax.xml.soap package has the following classes:

  • AttachmentPart This class represents the single attachment to the SOAPMessage object. A SOAPMessage object can contain multiple AttachmentPart objects.

  • MessageFactory This is a factory class for creating SOAPMessage objects.

  • MimeHeader This is a class that stores the MIME header name and its value.

  • MimeHeaders This class is a container for MimeHeader objects.

  • SOAPConnection This class represents a point-to-point connection that a client can use for sending messages directly to the recipient without using a messaging provider.

  • SOAPElementFactory This is a factory class for XML fragments that will eventually end up in the SOAP part. These fragments can be inserted as children of the SOAPHeader, SOAPBody, or SOAPEnvelope.

  • SOAPMessage This class is the root class of all SOAP messages.

  • SOAPPart This is a container class for the SOAP-specific portion of a SOAPMessage object.

The javax.xml.soap Exception

The javax.xml.soap package has the following exception:

  • SOAPException This exception is raised when a SOAP exception occurs. A JAXM exception occurs in situations such as the inability to set a header, send a message, or get a connection with the message provider.


printer-friendly version of this section  Print  e-mail this section  E-Mail  add a public, group or private note  Add Note  add a bookmark about this section  Add Bookmark    
Top

[0672324342/ch07lev1sec5]

 
 


JavaT APIs for XML Kick Start
JAX: Java APIs for XML Kick Start
ISBN: 0672324342
EAN: 2147483647
Year: 2002
Pages: 133

flylib.com © 2008-2017.
If you may any questions please contact us: flylib@qtcs.net