1 /*
   2  * Copyright (c) 2000, 2003, 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 Summary and suggested reading order:
  27 
  28 ==============================================================================
  29 Connection interceptor (called an ORBSocketFactory):
  30 
  31 Summary:
  32 
  33 The server side part of the ORBSocketFactory is told the type to
  34 create as well as a port number.
  35 
  36 The client side part of the ORBSocketFactory is called on every client
  37 request.  An ORB first asks the factory for type/host/port information
  38 (given an IOR).  If the ORB already has a connection of the
  39 type/host/port it will use the existing connection.  Otherwise it will
  40 then ask the factory to create a client socket, giving it that
  41 type/host/port.  Finally, the createSocket method may throw an
  42 exception to tell the ORB to ask it for type/host/port info again.
  43 The information passed back and forth between the ORB and factory can
  44 act as a cookie for the factory if desired.
  45 
  46 Interfaces:
  47 
  48         com.sun.corba.se.spi.legacy.connection.ORBSocketFactory
  49         com.sun.corba.se.spi.legacy.connection.EndPointInfo
  50         com.sun.corba.se.spi.legacy.connection.GetEndPointInfoAgainException
  51 
  52 ==============================================================================
  53 Access to a request's socket:
  54 
  55 Summary:
  56 
  57 The request's socket is available via ClientRequestInfo and
  58 ServerRequestInfo.  We enable this by having them implement the
  59 RequestInfoExt interface.
  60 
  61 Interfaces:
  62 
  63         com.sun.corba.se.spi.legacy.interceptor.RequestInfoExt
  64         com.sun.corba.se.spi.legacy.connection.Connection
  65 
  66 ==============================================================================
  67 Extending IORInfo to support the multiple server port API:
  68 
  69 Summary:
  70 
  71 We support the multiple server port API in PortableInterceptors by
  72 having IORInfo implement the IORInfoExt interface.  The description on
  73 how to use the multiple server port APIs is found in
  74 ORBSocketFactory.java.
  75 
  76 Interfaces:
  77 
  78        com.sun.corba.se.spi.legacy.interceptor.IORInfoExt
  79        com.sun.corba.se.spi.legacy.interceptor.UnknownType
  80 
  81 ;; End.
  82 
  83