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