corba/src/share/classes/javax/rmi/CORBA/UtilDelegate.java
author ohair
Tue, 25 May 2010 15:52:11 -0700
changeset 5555 b2b5ed3f0d0d
parent 4 02bb8761fcce
permissions -rw-r--r--
6943119: Rebrand source copyright notices Reviewed-by: darcy
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4
02bb8761fcce Initial load
duke
parents:
diff changeset
     1
/*
5555
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
     2
 * Copyright (c) 1999, 2001, Oracle and/or its affiliates. All rights reserved.
4
02bb8761fcce Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
02bb8761fcce Initial load
duke
parents:
diff changeset
     4
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
02bb8761fcce Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5555
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
4
02bb8761fcce Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5555
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
4
02bb8761fcce Initial load
duke
parents:
diff changeset
    10
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
02bb8761fcce Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
02bb8761fcce Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
02bb8761fcce Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
02bb8761fcce Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
02bb8761fcce Initial load
duke
parents:
diff changeset
    16
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
02bb8761fcce Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
02bb8761fcce Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
02bb8761fcce Initial load
duke
parents:
diff changeset
    20
 *
5555
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
b2b5ed3f0d0d 6943119: Rebrand source copyright notices
ohair
parents: 4
diff changeset
    23
 * questions.
4
02bb8761fcce Initial load
duke
parents:
diff changeset
    24
 */
02bb8761fcce Initial load
duke
parents:
diff changeset
    25
/*
02bb8761fcce Initial load
duke
parents:
diff changeset
    26
 * Licensed Materials - Property of IBM
02bb8761fcce Initial load
duke
parents:
diff changeset
    27
 * RMI-IIOP v1.0
02bb8761fcce Initial load
duke
parents:
diff changeset
    28
 * Copyright IBM Corp. 1998 1999  All Rights Reserved
02bb8761fcce Initial load
duke
parents:
diff changeset
    29
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
    30
 */
02bb8761fcce Initial load
duke
parents:
diff changeset
    31
02bb8761fcce Initial load
duke
parents:
diff changeset
    32
package javax.rmi.CORBA;
02bb8761fcce Initial load
duke
parents:
diff changeset
    33
02bb8761fcce Initial load
duke
parents:
diff changeset
    34
import java.io.Serializable;
02bb8761fcce Initial load
duke
parents:
diff changeset
    35
import java.rmi.Remote;
02bb8761fcce Initial load
duke
parents:
diff changeset
    36
import java.rmi.RemoteException;
02bb8761fcce Initial load
duke
parents:
diff changeset
    37
import javax.rmi.CORBA.Tie;
02bb8761fcce Initial load
duke
parents:
diff changeset
    38
import javax.rmi.CORBA.ValueHandler;
02bb8761fcce Initial load
duke
parents:
diff changeset
    39
import org.omg.CORBA.ORB;
02bb8761fcce Initial load
duke
parents:
diff changeset
    40
import org.omg.CORBA.portable.InputStream;
02bb8761fcce Initial load
duke
parents:
diff changeset
    41
import org.omg.CORBA.portable.OutputStream;
02bb8761fcce Initial load
duke
parents:
diff changeset
    42
import org.omg.CORBA.SystemException;
02bb8761fcce Initial load
duke
parents:
diff changeset
    43
02bb8761fcce Initial load
duke
parents:
diff changeset
    44
/**
02bb8761fcce Initial load
duke
parents:
diff changeset
    45
 * Supports delegation for method implementations in {@link Util}.  The
02bb8761fcce Initial load
duke
parents:
diff changeset
    46
 * delegate is a singleton instance of a class that implements this
02bb8761fcce Initial load
duke
parents:
diff changeset
    47
 * interface and provides a replacement implementation for all the
02bb8761fcce Initial load
duke
parents:
diff changeset
    48
 * methods of <code>javax.rmi.CORBA.Util</code>.
02bb8761fcce Initial load
duke
parents:
diff changeset
    49
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
    50
 * Delegation is enabled by providing the delegate's class name as the
02bb8761fcce Initial load
duke
parents:
diff changeset
    51
 * value of the
02bb8761fcce Initial load
duke
parents:
diff changeset
    52
 * <code>javax.rmi.CORBA.UtilClass</code>
02bb8761fcce Initial load
duke
parents:
diff changeset
    53
 * system property.
02bb8761fcce Initial load
duke
parents:
diff changeset
    54
 *
02bb8761fcce Initial load
duke
parents:
diff changeset
    55
 * @see Util
02bb8761fcce Initial load
duke
parents:
diff changeset
    56
 */
02bb8761fcce Initial load
duke
parents:
diff changeset
    57
public interface UtilDelegate {
02bb8761fcce Initial load
duke
parents:
diff changeset
    58
02bb8761fcce Initial load
duke
parents:
diff changeset
    59
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
    60
     * Delegation call for {@link Util#mapSystemException}.
02bb8761fcce Initial load
duke
parents:
diff changeset
    61
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
    62
    RemoteException mapSystemException(SystemException ex);
02bb8761fcce Initial load
duke
parents:
diff changeset
    63
02bb8761fcce Initial load
duke
parents:
diff changeset
    64
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
    65
     * Delegation call for {@link Util#writeAny}.
02bb8761fcce Initial load
duke
parents:
diff changeset
    66
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
    67
    void writeAny(OutputStream out, Object obj);
02bb8761fcce Initial load
duke
parents:
diff changeset
    68
02bb8761fcce Initial load
duke
parents:
diff changeset
    69
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
    70
     * Delegation call for {@link Util#readAny}.
02bb8761fcce Initial load
duke
parents:
diff changeset
    71
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
    72
    java.lang.Object readAny(InputStream in);
02bb8761fcce Initial load
duke
parents:
diff changeset
    73
02bb8761fcce Initial load
duke
parents:
diff changeset
    74
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
    75
     * Delegation call for {@link Util#writeRemoteObject}.
02bb8761fcce Initial load
duke
parents:
diff changeset
    76
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
    77
    void writeRemoteObject(OutputStream out, Object obj);
02bb8761fcce Initial load
duke
parents:
diff changeset
    78
02bb8761fcce Initial load
duke
parents:
diff changeset
    79
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
    80
     * Delegation call for {@link Util#writeAbstractObject}.
02bb8761fcce Initial load
duke
parents:
diff changeset
    81
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
    82
    void writeAbstractObject(OutputStream out, Object obj);
02bb8761fcce Initial load
duke
parents:
diff changeset
    83
02bb8761fcce Initial load
duke
parents:
diff changeset
    84
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
    85
     * Delegation call for {@link Util#registerTarget}.
02bb8761fcce Initial load
duke
parents:
diff changeset
    86
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
    87
    void registerTarget(Tie tie, Remote target);
02bb8761fcce Initial load
duke
parents:
diff changeset
    88
02bb8761fcce Initial load
duke
parents:
diff changeset
    89
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
    90
     * Delegation call for {@link Util#unexportObject}.
02bb8761fcce Initial load
duke
parents:
diff changeset
    91
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
    92
    void unexportObject(Remote target) throws java.rmi.NoSuchObjectException;
02bb8761fcce Initial load
duke
parents:
diff changeset
    93
02bb8761fcce Initial load
duke
parents:
diff changeset
    94
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
    95
     * Delegation call for {@link Util#getTie}.
02bb8761fcce Initial load
duke
parents:
diff changeset
    96
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
    97
    Tie getTie(Remote target);
02bb8761fcce Initial load
duke
parents:
diff changeset
    98
02bb8761fcce Initial load
duke
parents:
diff changeset
    99
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
   100
     * Delegation call for {@link Util#createValueHandler}.
02bb8761fcce Initial load
duke
parents:
diff changeset
   101
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
   102
    ValueHandler createValueHandler();
02bb8761fcce Initial load
duke
parents:
diff changeset
   103
02bb8761fcce Initial load
duke
parents:
diff changeset
   104
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
   105
     * Delegation call for {@link Util#getCodebase}.
02bb8761fcce Initial load
duke
parents:
diff changeset
   106
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
   107
    String getCodebase(Class clz);
02bb8761fcce Initial load
duke
parents:
diff changeset
   108
02bb8761fcce Initial load
duke
parents:
diff changeset
   109
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
   110
     * Delegation call for {@link Util#loadClass}.
02bb8761fcce Initial load
duke
parents:
diff changeset
   111
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
   112
    Class loadClass(String className, String remoteCodebase, ClassLoader loader)
02bb8761fcce Initial load
duke
parents:
diff changeset
   113
        throws ClassNotFoundException;
02bb8761fcce Initial load
duke
parents:
diff changeset
   114
02bb8761fcce Initial load
duke
parents:
diff changeset
   115
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
   116
     * Delegation call for {@link Util#isLocal}.
02bb8761fcce Initial load
duke
parents:
diff changeset
   117
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
   118
    boolean isLocal(Stub stub) throws RemoteException;
02bb8761fcce Initial load
duke
parents:
diff changeset
   119
02bb8761fcce Initial load
duke
parents:
diff changeset
   120
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
   121
     * Delegation call for {@link Util#wrapException}.
02bb8761fcce Initial load
duke
parents:
diff changeset
   122
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
   123
    RemoteException wrapException(Throwable obj);
02bb8761fcce Initial load
duke
parents:
diff changeset
   124
02bb8761fcce Initial load
duke
parents:
diff changeset
   125
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
   126
     * Delegation call for {@link Util#copyObject}.
02bb8761fcce Initial load
duke
parents:
diff changeset
   127
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
   128
    Object copyObject(Object obj, ORB orb) throws RemoteException;
02bb8761fcce Initial load
duke
parents:
diff changeset
   129
02bb8761fcce Initial load
duke
parents:
diff changeset
   130
    /**
02bb8761fcce Initial load
duke
parents:
diff changeset
   131
     * Delegation call for {@link Util#copyObjects}.
02bb8761fcce Initial load
duke
parents:
diff changeset
   132
     */
02bb8761fcce Initial load
duke
parents:
diff changeset
   133
    Object[] copyObjects(Object[] obj, ORB orb) throws RemoteException;
02bb8761fcce Initial load
duke
parents:
diff changeset
   134
02bb8761fcce Initial load
duke
parents:
diff changeset
   135
}