1 /*
   2  * Copyright (c) 2004, 2015, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package javax.xml.soap;
  27 
  28 /**
  29  * A factory for creating {@code SOAPConnection} objects. Implementation of this class
  30  * is optional. If {@code SOAPConnectionFactory.newInstance()} throws an
  31  * UnsupportedOperationException then the implementation does not support the
  32  * SAAJ communication infrastructure. Otherwise {@link SOAPConnection} objects
  33  * can be created by calling {@code createConnection()} on the newly
  34  * created {@code SOAPConnectionFactory} object.
  35  *
  36  * @since 1.6
  37  */
  38 public abstract class SOAPConnectionFactory {
  39 
  40     /**
  41      * A constant representing the default value for a {@code SOAPConnection}
  42      * object. The default is the point-to-point SOAP connection.
  43      */
  44     private static final String DEFAULT_SOAP_CONNECTION_FACTORY
  45             = "com.sun.xml.internal.messaging.saaj.client.p2p.HttpSOAPConnectionFactory";
  46 
  47     /**
  48      * Creates an instance of the default
  49      * {@code SOAPConnectionFactory} object.
  50      *
  51      * This method uses the lookup procedure specified in {@link javax.xml.soap} to locate and load the
  52      * {@link javax.xml.soap.SOAPConnectionFactory} class.
  53      *
  54      * @return a new instance of a default
  55      *         {@code SOAPConnectionFactory} object
  56      *
  57      * @exception SOAPException if there was an error creating the
  58      *            {@code SOAPConnectionFactory}
  59      *
  60      * @exception UnsupportedOperationException if newInstance is not
  61      * supported.
  62      */
  63     public static SOAPConnectionFactory newInstance()
  64         throws SOAPException, UnsupportedOperationException
  65     {
  66         try {
  67             return FactoryFinder.find(
  68                     SOAPConnectionFactory.class,
  69                     DEFAULT_SOAP_CONNECTION_FACTORY,
  70                     true);
  71         } catch (Exception ex) {
  72             throw new SOAPException("Unable to create SOAP connection factory: "
  73                                     +ex.getMessage());
  74         }
  75     }
  76 
  77     /**
  78      * Create a new {@code SOAPConnection}.
  79      *
  80      * @return the new {@code SOAPConnection} object.
  81      *
  82      * @exception SOAPException if there was an exception creating the
  83      * {@code SOAPConnection} object.
  84      */
  85     public abstract SOAPConnection createConnection()
  86         throws SOAPException;
  87 }