SOAPFactory

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS (src) NEXT CLASS (src)

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

javax.xml.soap
Class SOAPFactory

java.lang.Object
  javax.xml.soap.SOAPFactory

Direct Known Subclasses:: SOAPFactoryImpl (src)

public abstract class SOAPFactory
extends java.lang.Object

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 or other SOAPElement objects. SOAPFactory also has methods to create javax.xml.soap.Detail objects as well as java.xml.soap.Name objects.

Constructor Summary
`SOAPFactory()`

Method Summary
`abstract Detail (src)`	`createDetail()` Creates a new Detail object which serves as a container for DetailEntry objects.
`abstract SOAPElement (src)`	`createElement(Name (src) name)` Create a SOAPElement object initialized with the given Name object.
`abstract SOAPElement (src)`	`createElement(java.lang.String localName)` Create a SOAPElement object initialized with the given local name.
`abstract SOAPElement (src)`	`createElement(java.lang.String localName, java.lang.String prefix, java.lang.String uri)` Create a new SOAPElement object with the given local name, prefix and uri.
`abstract Name (src)`	`createName(java.lang.String localName)` Creates a new Name object initialized with the given local name.
`abstract Name (src)`	`createName(java.lang.String localName, java.lang.String prefix, java.lang.String uri)` Creates a new Name object initialized with the given local name, namespace prefix, and namespace URI.
`static SOAPFactory (src)`	`newInstance()` Creates a new instance of SOAPFactory.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SOAPFactory

public SOAPFactory()

Method Detail

newInstance

public static SOAPFactory (src)  newInstance()
                               throws SOAPException (src)

Creates a new instance of SOAPFactory.

Returns:: a new instance of a SOAPFactory
Throws:: SOAPException (src) - if there was an error creating the default SOAPFactory

createDetail

public abstract Detail (src)  createDetail()
                             throws SOAPException (src)

Creates a new Detail object which serves as a container for DetailEntry objects. This factory method creates Detail objects for use in situations where it is not practical to use the SOAPFault abstraction.

Returns:: a Detail object
Throws:: SOAPException (src) - if there is a SOAP error

createElement

public abstract SOAPElement (src)  createElement(java.lang.String localName)
                                   throws SOAPException (src)

Create a SOAPElement object initialized with the given local name.

Parameters:: localName - a String giving the local name for the new element
Returns:: the new SOAPElement object that was created
Throws:: SOAPException (src) - if there is an error in creating the SOAPElement object

createElement

public abstract SOAPElement (src)  createElement(java.lang.String localName,
                                          java.lang.String prefix,
                                          java.lang.String uri)
                                   throws SOAPException (src)

Create a new SOAPElement object with the given local name, prefix and uri.

Parameters:: localName - a String giving the local name for the new element; prefix - the prefix for this SOAPElement; uri - a String giving the URI of the namespace to which the new element belongs
Returns:: the new SOAPElement object that was created
Throws:: SOAPException (src) - if there is an error in creating the SOAPElement object

createElement

public abstract SOAPElement (src)  createElement(Name (src)  name)
                                   throws SOAPException (src)

Create a SOAPElement object initialized with the given Name object.

Parameters:: name - a Name object with the XML name for the new element
Returns:: the new SOAPElement object that was created
Throws:: SOAPException (src) - if there is an error in creating the SOAPElement object

createName

public abstract Name (src)  createName(java.lang.String localName)
                         throws SOAPException (src)

Creates a new Name object initialized with the given local name. This factory method creates Name objects for use in situations where it is not practical to use the SOAPEnvelope abstraction.

Returns:
Throws:: SOAPException (src)

createName

public abstract Name (src)  createName(java.lang.String localName,
                                java.lang.String prefix,
                                java.lang.String uri)
                         throws SOAPException (src)

Creates a new Name object initialized with the given local name, namespace prefix, and namespace URI. This factory method creates Name objects for use in situations where it is not practical to use the SOAPEnvelope abstraction.

Parameters:: localName - a String giving the local name; prefix - a String giving the prefix of the namespace; uri - a String giving the URI of the namespace
Returns:: a Name object initialized with the given local name, namespace prefix, and namespace URI
Throws:: SOAPException (src) - if there is a SOAP error