jdk/src/share/classes/java/rmi/server/ServerRef.java
author duke
Sat, 01 Dec 2007 00:00:00 +0000
changeset 2 90ce3da70b43
child 5506 202f599c92aa
permissions -rw-r--r--
Initial load
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
90ce3da70b43 Initial load
duke
parents:
diff changeset
     2
 * Copyright 1996-1999 Sun Microsystems, Inc.  All Rights Reserved.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
 * have any questions.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.rmi.server;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import java.rmi.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
 * A ServerRef represents the server-side handle for a remote object
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
 * implementation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * @author  Ann Wollrath
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * @since   JDK1.1
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
public interface ServerRef extends RemoteRef {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
    /** indicate compatibility with JDK 1.1.x version of class. */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
    static final long serialVersionUID = -4557750989390278438L;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
     * Creates a client stub object for the supplied Remote object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
     * If the call completes successfully, the remote object should
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
     * be able to accept incoming calls from clients.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
     * @param obj the remote object implementation
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
     * @param data information necessary to export the object
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
     * @return the stub for the remote object
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
     * @exception RemoteException if an exception occurs attempting
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
     * to export the object (e.g., stub class could not be found)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
     * @since JDK1.1
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
    RemoteStub exportObject(Remote obj, Object data)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
        throws RemoteException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
     * Returns the hostname of the current client.  When called from a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
     * thread actively handling a remote method invocation the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
     * hostname of the client is returned.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     * @return the client's host name
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
     * @exception ServerNotActiveException if called outside of servicing
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
     * a remote method invocation
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
     * @since JDK1.1
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
    String getClientHost() throws ServerNotActiveException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
}