Home >> All >> javax >> [ xml Javadoc ]

•	javax.xml.bind.* (31)	•	javax.xml.datatype.* (5)	•	javax.xml.messaging.* (2)
•	javax.xml.namespace.* (2)	•	javax.xml.parsers.* (6)	•	javax.xml.registry.* (50)
•	javax.xml.rpc.* (50)	•	javax.xml.soap.* (26)	•	javax.xml.stream.* (37)
•	javax.xml.transform.* (22)	•	javax.xml.validation.* (6)	•	javax.xml.xpath.* (11)

• javax.xml: Javadoc index of package javax.xml.


Package Samples:

• javax.xml.namespace: This package contains the JaxMeAPI , a clean room implementation of the JAXB API.  
• javax.xml.bind.util: Clean room implementation of the JAXB standard xml-binding API.  
• javax.xml.transform.dom: Base "TRAX" API for XSLT transformers.  
• javax.xml.transform.sax: Base "TRAX" API for XSLT transformers.  
• javax.xml.transform.stream: Base "TRAX" API for XSLT transformers.  
• javax.xml.parsers
• javax.xml.datatype
• javax.xml.transform
• javax.xml.validation
• javax.xml.xpath
• javax.xml.messaging
• javax.xml.rpc
• javax.xml.rpc.encoding
• javax.xml.rpc.handler
• javax.xml.rpc.handler.soap
• javax.xml.rpc.holders
• javax.xml.rpc.server
• javax.xml.rpc.soap
• javax.xml.soap
• javax.xml.bind.helpers

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 ...
• JAXBContext: The JAXBContext provides the JAXB users anchor to the implmentation and hos generated classes. A JAXBContext is used to obtain instances of Marshaller , Unmarshaller , and Validator . To obtain a JAXBContext, the application invokes JAXBContext context = JAXBContext.newInstance("com.mycompany:com.mycompany.xml"); The list of colon separated package names matches the list in the schemas used to generate classes. In other words: If you have a schema using package name "com.mycompany.xml", then this package name has to be part of the list. The JAXBContext class will scan the given list of packages ...
• 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 ...
• XMLInputFactory: Factory for creating stream and event readers from various kinds of input source. Parameters Name Description Type Default Required javax.xml.stream.isValidating Controls DTD validation Boolean Boolean.FALSE no javax.xml.stream.isNamespaceAware Controls namespace processing for XML 1.0 Boolean Boolean.TRUE true is required, false is optional javax.xml.stream.isCoalescing Controls coalescing (normalization of adjacent character data) Boolean Boolean.FALSE yes javax.xml.stream.isReplacingEntityReferences Controls replacement of entity references with their replacement text Boolean Boolean.TRUE yes ...
• Endpoint: An opaque representation of an application endpoint. Typically, an Endpoint object represents a business entity, but it may represent a party of any sort. Conceptually, an Endpoint object is the mapping of a logical name (example, a URI) to a physical location, such as a URL. For messaging using a provider that supports profiles, an application does not need to specify an endpoint when it sends a message because destination information will be contained in the profile-specific header. However, for point-to-point plain SOAP messaging, an application must supply an Endpoint object to the SOAPConnection ...
• 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 ...
• DatatypeConverterInterface: The DatatypeConverterInterface is a helper class for implementation of custom print() and parse() methods, as specified by jaxb:javaType/@printMethod and jaxb:javaType/@parseMethod . However, the JAXB user won't be accessing this class directly. The JAXB provider is required to create an instance of this class and pass it to the JAXB runtime by invoking DatatypeConverter.setDatatypeConverter(DatatypeConverterInterface) 55 . The JAXB user may access this instance via the static methods of DatatypeConverter . The interface provides methods parseFoo() and printFoo() for any XML Schema type foo . The ...
• 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 ...
• JAXBSource: This utility class allows to use a JAXB object as the source of a stylesheet transformation. If you depend on any methods from javax.xml.transform.sax.SAXSource , you should use this class. In particular, you must not use the methods SAXSource.setInputSource(InputSource) > SAXSource.setInputSource(InputSource) 55 , or SAXSource.setXMLReader(XMLReader) > SAXSource.setXMLReader(XMLReader) 55 on an instance of JAXBSource . If you depend on these methods, a replacement for the JAXBSource can be obtained as follows: javax.xml.bind.JAXBContext context; javax.xml.bind.Element object; java.io.StringWriter ...
• 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 ...
• ValidationEventHandler: An instance of ValidationEventHandler allows to customize the reply to instances of ValidationEvent . By default, there is a standard ValidationEventHandler , converting errors and fatal errors in Exceptions. The JAXB user creates instances of ValidationEventHandler and registers them with the Marshaller , Unmarshaller , or Validator . The JAXB provider is required not to throw exceptions directly, but to convert all detected problems into events, which are fired on the ValidationEventHandler .
• 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 ...
• Validator: A Validator may be used to decide, whether a JAXB object is valid or not. If it is not, the JAXB user may decide to trigger an exception or not (via the ValidationEventHandler and he may receive information on the problems location (via the event handlers ValidationEventLocator . A Validator may be present implicitly, invoked by the Unmarshaller. See Unmarshaller.setValidating(boolean) 55 for more information on that.
• Marshaller: An instance of Marshaller may be obtained by the JAXB user to serialize JAXB objects to various flavours of XML. The created XML may be: A byte stream java.io.OutputStream marshal(Object, java.io.OutputStream) 55 A character stream java.io.Writer marshal(Object, java.io.Writer) 55
• AbstractUnmarshallerImpl: This is an abstract default implementation of an javax.xml.bind.Unmarshaller . Subclasses only need to implement Unmarshaller.getUnmarshallerHandler() > Unmarshaller.getUnmarshallerHandler() 55 , Unmarshaller.unmarshal(org.w3c.dom.Node) > Unmarshaller.unmarshal(org.w3c.dom.Node) 55 , and unmarshal(org.xml.sax.XMLReader, org.xml.sax.InputSource) 55 .
• UnmarshallerHandler: This interface is the SAX org.xml.sax.ContentHandler representation of an Unmarshaller , as returned by Unmarshaller.getUnmarshallerHandler() 55 . It can be embedded into a stack of SAX handlers, for example within Apache Cocoon. The UnmarshallerHandler is reusable: The startDocument() method is expected to perform a reinitialization. Like most other SAX handlers, the UnmarshallerHandler is never thread safe.
• ServletEndpointContext: The ServletEndpointContext provides an endpoint context maintained by the underlying servlet container based JAX-RPC runtime system. For service endpoints deployed on a servlet container based JAX-RPC runtime system, the context parameter in the ServiceLifecycle.init method is required to be of the Java type javax.xml.rpc.server.ServletEndpointContext . A servlet container based JAX-RPC runtime system implements the ServletEndpointContext interface. The JAX-RPC runtime system is required to provide appropriate session, message context, servlet context and user principal information per method invocation ...
• ValidationEventLocator: The ValidationEventLocator is an abstract description of the place where a ValidationEvent occurred. Depending on the source or target media (Unmarshalling, or Unmarshalling) or the object being validated, you will most probably find that different fields of the ValidationEventHandler are set. For example, if you are using a org.xml.sax.ContentHandler , you will most probably find that those fields are set, which are common to a org.xml.sax.Locator .
• SOAPFaultException: The SOAPFaultException exception represents a SOAP fault. The message part in the SOAP fault maps to the contents of faultdetail element accessible through the getDetail method on the SOAPFaultException . The method createDetail on the javax.xml.soap.SOAPFactory creates an instance of the javax.xml.soap.Detail . The faultstring provides a human-readable description of the SOAP fault. The faultcode element provides an algorithmic mapping of the SOAP fault. Refer to SOAP 1.1 and WSDL 1.1 specifications for more details of the SOAP faults.
• GenericHandler: The javax.xml.rpc.handler.GenericHandler class implements the Handler interface. SOAP Message Handler developers should typically subclass GenericHandler class unless the Handler class needs another class as a superclass. The GenericHandler class is a convenience abstract class that makes writing Handlers easy. This class provides default implementations of the lifecycle methods init and destroy and also different handle methods. A Handler developer should only override methods that it needs to specialize as part of the derived Handler implementation class.
• 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);

Home | Contact Us | Privacy Policy | Terms of Service