Source for gnu.CORBA.interfaces.SocketFactory

   1: /* SocketFactory.java --
   2:    Copyright (C) 2005 Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package gnu.CORBA.interfaces;
  40: 
  41: import java.io.IOException;
  42: import java.net.ServerSocket;
  43: import java.net.Socket;
  44: 
  45: /**
  46:  * This class produces sockets for serving and submitting CORBA requests. The
  47:  * socket factory can be set using {@link gnuOrb.setSocketFactory()} for
  48:  * producting all sockets for that ORB. This is needed for using secure sockets,
  49:  * for implementing the desired timeout policies, for HTTP tunnels and in some
  50:  * other similar cases. While such functionality is provided by near all
  51:  * existing CORBA implementations, no standard mechanism is defined.
  52:  *
  53:  * The socket factory may need to put additional information to the IORs of the
  54:  * objects, released by the ORB. Because of this reason, this interface extends
  55:  * IORInterceptorOperations.
  56:  *
  57:  * @author Audrius Meskauskas, Lithuania (AudriusA@Bioinformatics.org)
  58:  */
  59: public interface SocketFactory
  60: {
  61:   /**
  62:    * The name of the ORB property that forces the ORB to use the socket
  63:    * factory class, the name of that (String) is the value of this property.
  64:    */
  65:   final String PROPERTY = "gnu.CORBA.SocketFactory";
  66: 
  67:   /**
  68:    * Create a server socket that should serve remote invocations on the given
  69:    * port. The ORB may use this socket to serve either one or more objects.
  70:    *
  71:    * @param port the port, on that the socket should be listening for requests.
  72:    * The port policy can be controlled by {@link gnuPortManager}.
  73:    *
  74:    * @throws IOException if the socket cannot be created on the given port due
  75:    * any reasons. The ORB may try to open the socket on another port, calling
  76:    * this method with the different parameter.
  77:    */
  78:   ServerSocket createServerSocket(int port)
  79:     throws IOException;
  80: 
  81:   /**
  82:    * Create a client socket that should send a request to the remote side. When
  83:    * returned, the socket should be opened and ready to communicate.
  84:    *
  85:    * @param port the port, on that the socket should be openend. The port is
  86:    * usually part of the internet profile.
  87:    *
  88:    * @throws IOException if the socket cannot be created on the given port due
  89:    * any reasons. The ORB may try to open the socket on another port, calling
  90:    * this method with the different parameter.
  91:    */
  92:   Socket createClientSocket(String host, int port)
  93:     throws IOException;
  94: 
  95: }