no.digipost.api.MessageFactorySupplier Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sdp-api-client Show documentation
Klientfunksjonaltet for Sikker Digital Post
The newest version!
package no.digipost.api;

import jakarta.xml.soap.MessageFactory;
import jakarta.xml.soap.SOAPConstants;
import jakarta.xml.soap.SOAPException;


@FunctionalInterface
public interface MessageFactorySupplier {

    /**
     * This resolves the {@link com.sun.xml.messaging.saaj.soap.ver1_2.SOAPMessageFactory1_2Impl} from the
     * Eclipse Enterprise for Java (EE4J) Metro SAAJ RI.
     * 
     * This is the default SAAJ implementation used by this library, and is preferred because the implementation
     * bundled in the JDK has certain concurrency issues.
     */
    static MessageFactorySupplier metroSaajRI() {
        return com.sun.xml.messaging.saaj.soap.ver1_2.SOAPMessageFactory1_2Impl::new;
    }

    /**
     * This resolves which MessageFactory implementation to use using standard JDK mechanism by
     * invoking {@link MessageFactory#newInstance(String)} with {@link SOAPConstants#SOAP_1_2_PROTOCOL} as
     * argument. This may be apropriate if you use an application server runtime environment, and you want
     * to use the SAAJ implementation supplied by it.
     *
     * 
Note:
     * The SAAJ implementation bundled with the JDK has certain performance and concurrency issues:
     * 

     *  Issue #73: Make EnvelopeFactory ParserPool capacity configurable
     *  Pull-request #117: Fix stability and security problem
     * 
     * You should not use this MessageFactoryResolver unless you have a good reason to, either if
     * you have configured your runtime environment to create a certain SAAJ implementation specified
     * by the {@code javax.xml.soap.MessageFactory} system property, or this is preconfigured
     * by your runtime environment, e.g. an application server.
     */
    static MessageFactorySupplier jdkFactory() {
        return () -> MessageFactory.newInstance(SOAPConstants.SOAP_1_2_PROTOCOL);
    }

    /**
     * Get the default {@code MessageFactorySupplier} (i.e. {@link #metroSaajRI()})
     * if given {@code null} as argument.
     *
     * @param messageFactory the factory to check if it is {@code null}.
     * @return the given {@code messageFactory} or if it is {@code null}, the result
     *         from {@link #metroSaajRI()}.
     */
    static MessageFactorySupplier defaultIfNull(MessageFactorySupplier messageFactory) {
        return messageFactory != null ? messageFactory : metroSaajRI();
    }



    MessageFactory createMessageFactory() throws SOAPException;

}