|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectjavax.xml.soap.MessageFactory
public abstract class MessageFactory
A factory for creating SOAPMessage objects.
A SAAJ client can create a MessageFactory object
using the method newInstance, as shown in the following
lines of code.
MessageFactory mf = MessageFactory.newInstance();
MessageFactory mf12 = MessageFactory.newInstance(SOAPConstants.SOAP_1_2_PROTOCOL);
All MessageFactory objects, regardless of how they are
created, will produce SOAPMessage objects that
have the following elements by default:
SOAPPart object
SOAPEnvelope object
SOAPBody object
SOAPHeader object
SOAPHeader object and the
SOAPBody object.
The content of a new SOAPMessage object depends on which of the two
MessageFactory methods is used to create it.
createMessage() createMessage(MimeHeaders, java.io.InputStream) -- message has
content from the InputStream object and headers from the
MimeHeaders object
| Constructor Summary | |
|---|---|
MessageFactory()
|
|
| Method Summary | |
|---|---|
abstract SOAPMessage |
createMessage()
Creates a new SOAPMessage object with the default
SOAPPart, SOAPEnvelope, SOAPBody,
and SOAPHeader objects. |
abstract SOAPMessage |
createMessage(MimeHeaders headers,
java.io.InputStream in)
Internalizes the contents of the given InputStream object into a
new SOAPMessage object and returns the SOAPMessage
object. |
static MessageFactory |
newInstance()
Creates a new MessageFactory object that is an instance
of the default implementation (SOAP 1.1),
This method uses the following ordered lookup procedure to determine the MessageFactory implementation class to load:
Use the javax.xml.soap.MessageFactory system property. |
static MessageFactory |
newInstance(java.lang.String protocol)
Creates a new MessageFactory object that is an instance
of the specified implementation. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public MessageFactory()
| Method Detail |
|---|
public static MessageFactory newInstance()
throws SOAPException
MessageFactory object that is an instance
of the default implementation (SOAP 1.1),
This method uses the following ordered lookup procedure to determine the MessageFactory implementation class to load:
MessageFactory
SOAPException - if there was an error in creating the
default implementation of the
MessageFactory.SAAJMetaFactory
public static MessageFactory newInstance(java.lang.String protocol)
throws SOAPException
MessageFactory object that is an instance
of the specified implementation. May be a dynamic message factory,
a SOAP 1.1 message factory, or a SOAP 1.2 message factory. A dynamic
message factory creates messages based on the MIME headers specified
as arguments to the createMessage method.
This method uses the SAAJMetaFactory to locate the implementation class
and create the MessageFactory instance.
protocol - a string constant representing the class of the
specified message factory implementation. May be
either DYNAMIC_SOAP_PROTOCOL,
DEFAULT_SOAP_PROTOCOL (which is the same
as) SOAP_1_1_PROTOCOL, or
SOAP_1_2_PROTOCOL.
MessageFactory
SOAPException - if there was an error in creating the
specified implementation of MessageFactory.SAAJMetaFactory
public abstract SOAPMessage createMessage()
throws SOAPException
SOAPMessage object with the default
SOAPPart, SOAPEnvelope, SOAPBody,
and SOAPHeader objects. Profile-specific message factories
can choose to prepopulate the SOAPMessage object with
profile-specific headers.
Content can be added to this message's SOAPPart object, and
the message can be sent "as is" when a message containing only a SOAP part
is sufficient. Otherwise, the SOAPMessage object needs
to create one or more AttachmentPart objects and
add them to itself. Any content that is not in XML format must be
in an AttachmentPart object.
SOAPMessage object
SOAPException - if a SOAP error occurs
java.lang.UnsupportedOperationException - if the protocol of this
MessageFactory instance is DYNAMIC_SOAP_PROTOCOL
public abstract SOAPMessage createMessage(MimeHeaders headers,
java.io.InputStream in)
throws java.io.IOException,
SOAPException
InputStream object into a
new SOAPMessage object and returns the SOAPMessage
object.
in - the InputStream object that contains the data
for a messageheaders - the transport-specific headers passed to the
message in a transport-independent fashion for creation of the
message
SOAPMessage object containing the data from
the given InputStream object
java.io.IOException - if there is a problem in reading data from
the input stream
SOAPException - may be thrown if the message is invalid
java.lang.IllegalArgumentException - if the MessageFactory
requires one or more MIME headers to be present in the
headers parameter and they are missing.
MessageFactory implementations for
SOAP_1_1_PROTOCOL or
SOAP_1_2_PROTOCOL must not throw
IllegalArgumentException for this reason.
|
DRAFT | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
Copyright © 2009 Sun Microsystems, Inc. All Rights Reserved. Use is subject to license terms.
Generated on 24-November-2009 03:24