javax.xml.soap.MessageFactory Maven / Gradle / Ivy
/*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright (c) 2004-2011 Oracle and/or its affiliates. All rights reserved.
*
* The contents of this file are subject to the terms of either the GNU
* General Public License Version 2 only ("GPL") or the Common Development
* and Distribution License("CDDL") (collectively, the "License"). You
* may not use this file except in compliance with the License. You can
* obtain a copy of the License at
* https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
* or packager/legal/LICENSE.txt. See the License for the specific
* language governing permissions and limitations under the License.
*
* When distributing the software, include this License Header Notice in each
* file and include the License file at packager/legal/LICENSE.txt.
*
* GPL Classpath Exception:
* Oracle designates this particular file as subject to the "Classpath"
* exception as provided by Oracle in the GPL Version 2 section of the License
* file that accompanied this code.
*
* Modifications:
* If applicable, add the following below the License Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyright [year] [name of copyright owner]"
*
* Contributor(s):
* If you wish your version of this file to be governed by only the CDDL or
* only the GPL Version 2, indicate your decision by adding "[Contributor]
* elects to include this software in this distribution under the [CDDL or GPL
* Version 2] license." If you don't indicate a single choice of license, a
* recipient has the option to distribute your version of this file under
* either the CDDL, the GPL Version 2 or to extend the choice of license to
* its licensees as provided above. However, if you add GPL Version 2 code
* and therefore, elected the GPL Version 2 license, then the option applies
* only if the new code is made subject to such option by the copyright
* holder.
*/
package javax.xml.soap;
import java.io.IOException;
import java.io.InputStream;
/**
* 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:
*
* - A
SOAPPart object
* - A
SOAPEnvelope object
* - A
SOAPBody object
* - A
SOAPHeader object
*
* In some cases, specialized MessageFactory objects may be obtained that produce messages
* prepopulated with additional entries in the 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()
* This is the method clients would normally use to create a request message.
* createMessage(MimeHeaders, java.io.InputStream) -- message has
* content from the InputStream object and headers from the
* MimeHeaders object
* This method can be used internally by a service implementation to
* create a message that is a response to a request.
*
*/
public abstract class MessageFactory {
static private final String DEFAULT_MESSAGE_FACTORY
= "com.sun.xml.messaging.saaj.soap.ver1_1.SOAPMessageFactory1_1Impl";
static private final String MESSAGE_FACTORY_PROPERTY
= "javax.xml.soap.MessageFactory";
/**
* 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.
*
- 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.
*
*
* @return a new instance of a MessageFactory
*
* @exception SOAPException if there was an error in creating the
* default implementation of the
* MessageFactory.
* @see SAAJMetaFactory
*/
public static MessageFactory newInstance()
throws SOAPException {
try {
MessageFactory factory = (MessageFactory)
FactoryFinder.find(MESSAGE_FACTORY_PROPERTY);
if (factory != null)
return factory;
return newInstance(SOAPConstants.SOAP_1_1_PROTOCOL);
} catch (Exception ex) {
throw new SOAPException(
"Unable to create message factory for SOAP: "
+ex.getMessage());
}
}
/**
* Creates a new 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.
*
* @return a new instance of a MessageFactory
*
* @param 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.
*
* @exception SOAPException if there was an error in creating the
* specified implementation of MessageFactory.
* @see SAAJMetaFactory
* @since SAAJ 1.3
*/
public static MessageFactory newInstance(String protocol) throws SOAPException {
return SAAJMetaFactory.getInstance().newMessageFactory(protocol);
}
/**
* Creates a new 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.
*
* @return a new SOAPMessage object
* @exception SOAPException if a SOAP error occurs
* @exception UnsupportedOperationException if the protocol of this
* MessageFactory instance is DYNAMIC_SOAP_PROTOCOL
*/
public abstract SOAPMessage createMessage()
throws SOAPException;
/**
* Internalizes the contents of the given InputStream object into a
* new SOAPMessage object and returns the SOAPMessage
* object.
*
* @param in the InputStream object that contains the data
* for a message
* @param headers the transport-specific headers passed to the
* message in a transport-independent fashion for creation of the
* message
* @return a new SOAPMessage object containing the data from
* the given InputStream object
*
* @exception IOException if there is a problem in reading data from
* the input stream
*
* @exception SOAPException may be thrown if the message is invalid
*
* @exception 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.
*/
public abstract SOAPMessage createMessage(MimeHeaders headers,
InputStream in)
throws IOException, SOAPException;
}