1/*
2 * Copyright (c) 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
26package com.sun.jmx.remote.internal.rmi;
27
28import java.rmi.NoSuchObjectException;
29import java.rmi.Remote;
30import java.rmi.RemoteException;
31import java.rmi.server.RMIClientSocketFactory;
32import java.rmi.server.RMIServerSocketFactory;
33import java.rmi.server.UnicastRemoteObject;
34
35/**
36 * <p>Unpublished interface controlling how the RMI Connector Server
37 * exports objects.  The RMIServerImpl object and each
38 * RMIConnectionImpl object are exported using the exporter.  The
39 * default exporter calls {@link
40 * UnicastRemoteObject#exportObject(Remote, int,
41 * RMIClientSocketFactory, RMIServerSocketFactory)} to export objects
42 * and {@link UnicastRemoteObject#unexportObject(Remote, boolean)} to
43 * unexport them.  A replacement exporter can be specified via the
44 * {@link #EXPORTER_ATTRIBUTE} property in the environment Map passed
45 * to the RMI connector server.</p>
46 */
47public interface RMIExporter {
48    public static final String EXPORTER_ATTRIBUTE =
49        "com.sun.jmx.remote.rmi.exporter";
50
51    public Remote exportObject(Remote obj,
52                               int port,
53                               RMIClientSocketFactory csf,
54                               RMIServerSocketFactory ssf)
55            throws RemoteException;
56
57    public boolean unexportObject(Remote obj, boolean force)
58            throws NoSuchObjectException;
59}
60