jakarta.xml.soap.SAAJMetaFactory Maven / Gradle / Ivy
/*
* Copyright (c) 2004, 2022 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package jakarta.xml.soap;
/**
* The access point for the implementation classes of the factories defined in the
* SAAJ API. The {@code newInstance} methods defined on factories {@link SOAPFactory} and
* {@link MessageFactory} in SAAJ 1.4 defer to instances of this class to do the actual object creation.
* The implementations of {@code newInstance()} methods (in {@link SOAPFactory} and {@link MessageFactory})
* that existed in SAAJ 1.2 have been updated to also delegate to the SAAJMetaFactory when the SAAJ 1.2
* defined lookup fails to locate the Factory implementation class name.
*
*
* SAAJMetaFactory is a service provider interface and it uses similar lookup mechanism as other SAAJ factories
* to get actual instance:
*
*
* - If a system property with name {@code jakarta.xml.soap.SAAJMetaFactory} exists then its value is assumed
* to be the fully qualified name of the implementation class. This phase of the look up enables per-JVM
* override of the SAAJ implementation.
*
- If a system property with name {@code jakarta.xml.soap.MetaFactory} exists then its value is assumed
* to be the fully qualified name of the implementation class. This property, defined by previous specifications
* (up to 1.3), is still supported, but it is strongly recommended to migrate to new property
* {@code jakarta.xml.soap.SAAJMetaFactory}.
*
- Use the service-provider loading facilities, defined by the {@link java.util.ServiceLoader} class,
* to attempt to locate and load an implementation of the service using the {@linkplain
* java.util.ServiceLoader#load(java.lang.Class) default loading mechanism}.
*
- Finally, if all the steps above fail, platform default implementation is used.
*
*
*
* There are no public methods on this
* class.
*
* @author SAAJ RI Development Team
* @since 1.6, SAAJ 1.3
*/
public abstract class SAAJMetaFactory {
private static final String DEFAULT_META_FACTORY_CLASS =
"com.sun.xml.messaging.saaj.soap.SAAJMetaFactoryImpl";
/**
* Creates a new instance of a concrete {@code SAAJMetaFactory} object.
* The SAAJMetaFactory is an SPI, it pulls the creation of the other factories together into a
* single place. Changing out the SAAJMetaFactory has the effect of changing out the entire SAAJ
* implementation. Service providers provide the name of their {@code SAAJMetaFactory}
* implementation.
*
* This method uses the lookup procedure specified in {@link jakarta.xml.soap} to locate and load the
* {@link jakarta.xml.soap.SAAJMetaFactory} class.
*
* @return a concrete {@code SAAJMetaFactory} object
* @exception SOAPException if there is an error in creating the {@code SAAJMetaFactory}
*/
static SAAJMetaFactory getInstance() throws SOAPException {
try {
return FactoryFinder.find(
SAAJMetaFactory.class,
DEFAULT_META_FACTORY_CLASS,
true);
} catch (Exception e) {
throw new SOAPException(
"Unable to create SAAJ meta-factory: " + e.getMessage());
}
}
/**
* Default constructor.
*/
protected SAAJMetaFactory() { }
/**
* Creates a {@code MessageFactory} object for
* the given {@code String} protocol.
*
* @param protocol a {@code String} indicating the protocol
* @return a {@link MessageFactory}, not null
* @exception SOAPException if there is an error in creating the
* MessageFactory
* @see SOAPConstants#SOAP_1_1_PROTOCOL
* @see SOAPConstants#SOAP_1_2_PROTOCOL
* @see SOAPConstants#DYNAMIC_SOAP_PROTOCOL
*/
protected abstract MessageFactory newMessageFactory(String protocol)
throws SOAPException;
/**
* Creates a {@code SOAPFactory} object for
* the given {@code String} protocol.
*
* @param protocol a {@code String} indicating the protocol
* @return a {@link SOAPFactory}, not null
* @exception SOAPException if there is an error in creating the
* SOAPFactory
* @see SOAPConstants#SOAP_1_1_PROTOCOL
* @see SOAPConstants#SOAP_1_2_PROTOCOL
* @see SOAPConstants#DYNAMIC_SOAP_PROTOCOL
*/
protected abstract SOAPFactory newSOAPFactory(String protocol)
throws SOAPException;
}