- java.lang.Object
-
- javax.xml.soap.MessageFactory
-
public abstract class MessageFactory extends Object
A factory for creatingSOAPMessage
objects.A SAAJ client can create a
MessageFactory
object using the methodnewInstance
, 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 produceSOAPMessage
objects that have the following elements by default:- A
SOAPPart
object - A
SOAPEnvelope
object - A
SOAPBody
object - A
SOAPHeader
object
SOAPHeader
object and theSOAPBody
object. The content of a newSOAPMessage
object depends on which of the twoMessageFactory
methods is used to create it.createMessage()
This is the method clients would normally use to create a request message.createMessage(MimeHeaders, java.io.InputStream)
-- message has content from theInputStream
object and headers from theMimeHeaders
object
This method can be used internally by a service implementation to create a message that is a response to a request.
- A
-
-
Constructor Summary
Constructors Constructor and Description MessageFactory()
-
Method Summary
Methods Modifier and Type Method and Description abstract SOAPMessage
createMessage()
Creates a newSOAPMessage
object with the defaultSOAPPart
,SOAPEnvelope
,SOAPBody
, andSOAPHeader
objects.abstract SOAPMessage
createMessage(MimeHeaders headers, InputStream in)
Internalizes the contents of the givenInputStream
object into a newSOAPMessage
object and returns theSOAPMessage
object.static MessageFactory
newInstance()
Creates a newMessageFactory
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(String protocol)
Creates a newMessageFactory
object that is an instance of the specified implementation.
-
-
-
Method Detail
-
newInstance
public static MessageFactory newInstance() throws SOAPException
Creates a newMessageFactory
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.
- Use the properties file "lib/jaxm.properties" in the JRE directory. This configuration file is in standard java.util.Properties format and contains the fully qualified name of the implementation class with the key being the system property defined above.
- Use the Services API (as detailed in the JAR specification), if available, to determine the classname. The Services API will look for a classname in the file META-INF/services/javax.xml.soap.MessageFactory in jars available to the runtime.
- Use the SAAJMetaFactory instance to locate the MessageFactory implementation class.
- Returns:
- a new instance of a
MessageFactory
- Throws:
SOAPException
- if there was an error in creating the default implementation of theMessageFactory
.- See Also:
SAAJMetaFactory
-
newInstance
public static MessageFactory newInstance(String protocol) throws SOAPException
Creates a newMessageFactory
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 thecreateMessage
method. This method uses the SAAJMetaFactory to locate the implementation class and create the MessageFactory instance.- Parameters:
protocol
- a string constant representing the class of the specified message factory implementation. May be eitherDYNAMIC_SOAP_PROTOCOL
,DEFAULT_SOAP_PROTOCOL
(which is the same as)SOAP_1_1_PROTOCOL
, orSOAP_1_2_PROTOCOL
.- Returns:
- a new instance of a
MessageFactory
- Throws:
SOAPException
- if there was an error in creating the specified implementation ofMessageFactory
.- Since:
- SAAJ 1.3
- See Also:
SAAJMetaFactory
-
createMessage
public abstract SOAPMessage createMessage() throws SOAPException
Creates a newSOAPMessage
object with the defaultSOAPPart
,SOAPEnvelope
,SOAPBody
, andSOAPHeader
objects. Profile-specific message factories can choose to prepopulate theSOAPMessage
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, theSOAPMessage
object needs to create one or moreAttachmentPart
objects and add them to itself. Any content that is not in XML format must be in anAttachmentPart
object.- Returns:
- a new
SOAPMessage
object - Throws:
SOAPException
- if a SOAP error occursUnsupportedOperationException
- if the protocol of thisMessageFactory
instance isDYNAMIC_SOAP_PROTOCOL
-
createMessage
public abstract SOAPMessage createMessage(MimeHeaders headers, InputStream in) throws IOException, SOAPException
Internalizes the contents of the givenInputStream
object into a newSOAPMessage
object and returns theSOAPMessage
object.- Parameters:
in
- theInputStream
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- Returns:
- a new
SOAPMessage
object containing the data from the givenInputStream
object - Throws:
IOException
- if there is a problem in reading data from the input streamSOAPException
- may be thrown if the message is invalidIllegalArgumentException
- if theMessageFactory
requires one or more MIME headers to be present in theheaders
parameter and they are missing.MessageFactory
implementations forSOAP_1_1_PROTOCOL
orSOAP_1_2_PROTOCOL
must not throwIllegalArgumentException
for this reason.
-
-
Deutsche Übersetzung
Sie haben gebeten, diese Seite auf Deutsch zu besuchen. Momentan ist nur die Oberfläche übersetzt, aber noch nicht der gesamte Inhalt.Wenn Sie mir bei Übersetzungen helfen wollen, ist Ihr Beitrag willkommen. Alles, was Sie tun müssen, ist, sich auf der Website zu registrieren und mir eine Nachricht zu schicken, in der Sie gebeten werden, Sie der Gruppe der Übersetzer hinzuzufügen, die Ihnen die Möglichkeit gibt, die gewünschten Seiten zu übersetzen. Ein Link am Ende jeder übersetzten Seite zeigt an, dass Sie der Übersetzer sind und einen Link zu Ihrem Profil haben.
Vielen Dank im Voraus.
Dokument erstellt 11/06/2005, zuletzt geändert 04/03/2020
Quelle des gedruckten Dokuments:https://www.gaudry.be/de/java-api-rf-javax/xml/soap/messagefactory.html
Die Infobro ist eine persönliche Seite, deren Inhalt in meiner alleinigen Verantwortung liegt. Der Text ist unter der CreativeCommons-Lizenz (BY-NC-SA) verfügbar. Weitere Informationen auf die Nutzungsbedingungen und dem Autor.
Referenzen
Diese Verweise und Links verweisen auf Dokumente, die während des Schreibens dieser Seite konsultiert wurden, oder die zusätzliche Informationen liefern können, aber die Autoren dieser Quellen können nicht für den Inhalt dieser Seite verantwortlich gemacht werden.
Der Autor Diese Website ist allein dafür verantwortlich, wie die verschiedenen Konzepte und Freiheiten, die mit den Nachschlagewerken gemacht werden, hier dargestellt werden. Denken Sie daran, dass Sie mehrere Quellinformationen austauschen müssen, um das Risiko von Fehlern zu reduzieren.