src/java.rmi/share/classes/java/rmi/server/ServerRef.java
author darcy
Fri, 17 Aug 2018 13:37:01 -0700
changeset 51437 6221a199ec20
parent 51317 e122220d7d7e
permissions -rw-r--r--
8209304: Deprecate serialVersionUID fields in interfaces Reviewed-by: lancea, mullan, rriggs, smarks
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
51317
e122220d7d7e 8209024: Use SuppressWarnings on serialVersionUID fields in interfaces
darcy
parents: 47216
diff changeset
     2
 * Copyright (c) 1996, 2018, Oracle and/or its affiliates. All rights reserved.
2
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
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
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
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
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
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 21338
diff changeset
    35
 * @since   1.1
21338
ed59bead7654 8026427: deprecate obsolete APIs from java.rmi
smarks
parents: 5506
diff changeset
    36
 * @deprecated No replacement. This interface is unused and is obsolete.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 */
21338
ed59bead7654 8026427: deprecate obsolete APIs from java.rmi
smarks
parents: 5506
diff changeset
    38
@Deprecated
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
public interface ServerRef extends RemoteRef {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
51437
6221a199ec20 8209304: Deprecate serialVersionUID fields in interfaces
darcy
parents: 51317
diff changeset
    41
    /** indicate compatibility with JDK 1.1.x version of class.
6221a199ec20 8209304: Deprecate serialVersionUID fields in interfaces
darcy
parents: 51317
diff changeset
    42
     *
6221a199ec20 8209304: Deprecate serialVersionUID fields in interfaces
darcy
parents: 51317
diff changeset
    43
     * @deprecated A {@code serialVersionUID} field in an interface is
6221a199ec20 8209304: Deprecate serialVersionUID fields in interfaces
darcy
parents: 51317
diff changeset
    44
     * ineffectual. Do not use; no replacement.
6221a199ec20 8209304: Deprecate serialVersionUID fields in interfaces
darcy
parents: 51317
diff changeset
    45
     */
6221a199ec20 8209304: Deprecate serialVersionUID fields in interfaces
darcy
parents: 51317
diff changeset
    46
    @Deprecated
6221a199ec20 8209304: Deprecate serialVersionUID fields in interfaces
darcy
parents: 51317
diff changeset
    47
    @SuppressWarnings("serial")
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
    static final long serialVersionUID = -4557750989390278438L;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
     * Creates a client stub object for the supplied Remote object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
     * If the call completes successfully, the remote object should
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
     * be able to accept incoming calls from clients.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
     * @param obj the remote object implementation
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
     * @param data information necessary to export the object
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
     * @return the stub for the remote object
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
     * @exception RemoteException if an exception occurs attempting
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
     * to export the object (e.g., stub class could not be found)
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 21338
diff changeset
    59
     * @since 1.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
    RemoteStub exportObject(Remote obj, Object data)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
        throws RemoteException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     * Returns the hostname of the current client.  When called from a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * thread actively handling a remote method invocation the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     * hostname of the client is returned.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     * @return the client's host name
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     * @exception ServerNotActiveException if called outside of servicing
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     * a remote method invocation
24865
09b1d992ca72 8044740: Convert all JDK versions used in @since tag to 1.n[.n] in jdk repo
henryjen
parents: 21338
diff changeset
    71
     * @since 1.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
    String getClientHost() throws ServerNotActiveException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
}