src/share/jaxws_classes/javax/xml/soap/SAAJMetaFactory.java

Tue, 06 Mar 2012 16:09:35 -0800

author
ohair
date
Tue, 06 Mar 2012 16:09:35 -0800
changeset 286
f50545b5e2f1
child 368
0989ad8c0860
permissions
-rw-r--r--

7150322: Stop using drop source bundles in jaxws
Reviewed-by: darcy, ohrstrom

ohair@286 1 /*
ohair@286 2 * Copyright (c) 2004, 2011, Oracle and/or its affiliates. All rights reserved.
ohair@286 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ohair@286 4 *
ohair@286 5 * This code is free software; you can redistribute it and/or modify it
ohair@286 6 * under the terms of the GNU General Public License version 2 only, as
ohair@286 7 * published by the Free Software Foundation. Oracle designates this
ohair@286 8 * particular file as subject to the "Classpath" exception as provided
ohair@286 9 * by Oracle in the LICENSE file that accompanied this code.
ohair@286 10 *
ohair@286 11 * This code is distributed in the hope that it will be useful, but WITHOUT
ohair@286 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ohair@286 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
ohair@286 14 * version 2 for more details (a copy is included in the LICENSE file that
ohair@286 15 * accompanied this code).
ohair@286 16 *
ohair@286 17 * You should have received a copy of the GNU General Public License version
ohair@286 18 * 2 along with this work; if not, write to the Free Software Foundation,
ohair@286 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ohair@286 20 *
ohair@286 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@286 22 * or visit www.oracle.com if you need additional information or have any
ohair@286 23 * questions.
ohair@286 24 */
ohair@286 25
ohair@286 26 package javax.xml.soap;
ohair@286 27
ohair@286 28 /**
ohair@286 29 * The access point for the implementation classes of the factories defined in the
ohair@286 30 * SAAJ API. All of the <code>newInstance</code> methods defined on factories in
ohair@286 31 * SAAJ 1.3 defer to instances of this class to do the actual object creation.
ohair@286 32 * The implementations of <code>newInstance()</code> methods (in SOAPFactory and MessageFactory)
ohair@286 33 * that existed in SAAJ 1.2 have been updated to also delegate to the SAAJMetaFactory when the SAAJ 1.2
ohair@286 34 * defined lookup fails to locate the Factory implementation class name.
ohair@286 35 *
ohair@286 36 * <p>
ohair@286 37 * SAAJMetaFactory is a service provider interface. There are no public methods on this
ohair@286 38 * class.
ohair@286 39 *
ohair@286 40 * @author SAAJ RI Development Team
ohair@286 41 * @since SAAJ 1.3
ohair@286 42 */
ohair@286 43
ohair@286 44 public abstract class SAAJMetaFactory {
ohair@286 45 static private final String META_FACTORY_CLASS_PROPERTY =
ohair@286 46 "javax.xml.soap.MetaFactory";
ohair@286 47 static private final String DEFAULT_META_FACTORY_CLASS =
ohair@286 48 "com.sun.xml.internal.messaging.saaj.soap.SAAJMetaFactoryImpl";
ohair@286 49
ohair@286 50 /**
ohair@286 51 * Creates a new instance of a concrete <code>SAAJMetaFactory</code> object.
ohair@286 52 * The SAAJMetaFactory is an SPI, it pulls the creation of the other factories together into a
ohair@286 53 * single place. Changing out the SAAJMetaFactory has the effect of changing out the entire SAAJ
ohair@286 54 * implementation. Service providers provide the name of their <code>SAAJMetaFactory</code>
ohair@286 55 * implementation.
ohair@286 56 *
ohair@286 57 * This method uses the following ordered lookup procedure to determine the SAAJMetaFactory implementation class to load:
ohair@286 58 * <UL>
ohair@286 59 * <LI> Use the javax.xml.soap.MetaFactory system property.
ohair@286 60 * <LI> Use the properties file "lib/jaxm.properties" in the JRE directory. This configuration file is in standard
ohair@286 61 * java.util.Properties format and contains the fully qualified name of the implementation class with the key being the
ohair@286 62 * system property defined above.
ohair@286 63 * <LI> Use the Services API (as detailed in the JAR specification), if available, to determine the classname. The Services API
ohair@286 64 * will look for a classname in the file META-INF/services/javax.xml.soap.MetaFactory in jars available to the runtime.
ohair@286 65 * <LI> Default to com.sun.xml.internal.messaging.saaj.soap.SAAJMetaFactoryImpl.
ohair@286 66 * </UL>
ohair@286 67 *
ohair@286 68 * @return a concrete <code>SAAJMetaFactory</code> object
ohair@286 69 * @exception SOAPException if there is an error in creating the <code>SAAJMetaFactory</code>
ohair@286 70 */
ohair@286 71 static SAAJMetaFactory getInstance() throws SOAPException {
ohair@286 72 try {
ohair@286 73 SAAJMetaFactory instance =
ohair@286 74 (SAAJMetaFactory) FactoryFinder.find(
ohair@286 75 META_FACTORY_CLASS_PROPERTY,
ohair@286 76 DEFAULT_META_FACTORY_CLASS);
ohair@286 77 return instance;
ohair@286 78 } catch (Exception e) {
ohair@286 79 throw new SOAPException(
ohair@286 80 "Unable to create SAAJ meta-factory" + e.getMessage());
ohair@286 81 }
ohair@286 82 }
ohair@286 83
ohair@286 84 protected SAAJMetaFactory() { }
ohair@286 85
ohair@286 86 /**
ohair@286 87 * Creates a <code>MessageFactory</code> object for
ohair@286 88 * the given <code>String</code> protocol.
ohair@286 89 *
ohair@286 90 * @param protocol a <code>String</code> indicating the protocol
ohair@286 91 * @exception SOAPException if there is an error in creating the
ohair@286 92 * MessageFactory
ohair@286 93 * @see SOAPConstants#SOAP_1_1_PROTOCOL
ohair@286 94 * @see SOAPConstants#SOAP_1_2_PROTOCOL
ohair@286 95 * @see SOAPConstants#DYNAMIC_SOAP_PROTOCOL
ohair@286 96 */
ohair@286 97 protected abstract MessageFactory newMessageFactory(String protocol)
ohair@286 98 throws SOAPException;
ohair@286 99
ohair@286 100 /**
ohair@286 101 * Creates a <code>SOAPFactory</code> object for
ohair@286 102 * the given <code>String</code> protocol.
ohair@286 103 *
ohair@286 104 * @param protocol a <code>String</code> indicating the protocol
ohair@286 105 * @exception SOAPException if there is an error in creating the
ohair@286 106 * SOAPFactory
ohair@286 107 * @see SOAPConstants#SOAP_1_1_PROTOCOL
ohair@286 108 * @see SOAPConstants#SOAP_1_2_PROTOCOL
ohair@286 109 * @see SOAPConstants#DYNAMIC_SOAP_PROTOCOL
ohair@286 110 */
ohair@286 111 protected abstract SOAPFactory newSOAPFactory(String protocol)
ohair@286 112 throws SOAPException;
ohair@286 113 }

mercurial