1 /*
   2  * Copyright (c) 2004, 2013, 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</code> objects. Implementation of this class
  30  * is optional. If <code>SOAPConnectionFactory.newInstance()</code> 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()</code> on the newly
  34  * created <code>SOAPConnectionFactory</code> object.
  35  *
  36  * @since 1.6
  37  */
  38 public abstract class SOAPConnectionFactory {
  39     /**
  40      * A constant representing the default value for a <code>SOAPConnection</code>
  41      * object. The default is the point-to-point SOAP connection.
  42      */
  43     static final String DEFAULT_SOAP_CONNECTION_FACTORY
  44         = "com.sun.xml.internal.messaging.saaj.client.p2p.HttpSOAPConnectionFactory";
  45 
  46     /**
  47      * A constant representing the <code>SOAPConnection</code> class.
  48      */
  49     static private final String SF_PROPERTY
  50         = "javax.xml.soap.SOAPConnectionFactory";
  51 
  52     /**
  53      * Creates an instance of the default
  54      * <code>SOAPConnectionFactory</code> object.
  55      *
  56      * @return a new instance of a default
  57      *         <code>SOAPConnectionFactory</code> object
  58      *
  59      * @exception SOAPException if there was an error creating the
  60      *            <code>SOAPConnectionFactory</code>
  61      *
  62      * @exception UnsupportedOperationException if newInstance is not
  63      * supported.
  64      */
  65     public static SOAPConnectionFactory newInstance()
  66         throws SOAPException, UnsupportedOperationException
  67     {
  68         try {
  69         return (SOAPConnectionFactory)
  70                 FactoryFinder.find(SF_PROPERTY,
  71                                    DEFAULT_SOAP_CONNECTION_FACTORY);
  72         } catch (Exception ex) {
  73             throw new SOAPException("Unable to create SOAP connection factory: "
  74                                     +ex.getMessage());
  75         }
  76     }
  77 
  78     /**
  79      * Create a new <code>SOAPConnection</code>.
  80      *
  81      * @return the new <code>SOAPConnection</code> object.
  82      *
  83      * @exception SOAPException if there was an exception creating the
  84      * <code>SOAPConnection</code> object.
  85      */
  86     public abstract SOAPConnection createConnection()
  87         throws SOAPException;
  88 }
--- EOF ---