001 /* RMIServer.java -- RMI object for connecting to an RMI JMX connector.
002 Copyright (C) 2007 Free Software Foundation, Inc.
003
004 This file is part of GNU Classpath.
005
006 GNU Classpath is free software; you can redistribute it and/or modify
007 it under the terms of the GNU General Public License as published by
008 the Free Software Foundation; either version 2, or (at your option)
009 any later version.
010
011 GNU Classpath is distributed in the hope that it will be useful, but
012 WITHOUT ANY WARRANTY; without even the implied warranty of
013 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
014 General Public License for more details.
015
016 You should have received a copy of the GNU General Public License
017 along with GNU Classpath; see the file COPYING. If not, write to the
018 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
019 02110-1301 USA.
020
021 Linking this library statically or dynamically with other modules is
022 making a combined work based on this library. Thus, the terms and
023 conditions of the GNU General Public License cover the whole
024 combination.
025
026 As a special exception, the copyright holders of this library give you
027 permission to link this library with independent modules to produce an
028 executable, regardless of the license terms of these independent
029 modules, and to copy and distribute the resulting executable under
030 terms of your choice, provided that you also meet, for each linked
031 independent module, the terms and conditions of the license of that
032 module. An independent module is a module which is not derived from
033 or based on this library. If you modify this library, you may extend
034 this exception to your version of the library, but you are not
035 obligated to do so. If you do not wish to do so, delete this
036 exception statement from your version. */
037
038 package javax.management.remote.rmi;
039
040 import java.io.IOException;
041
042 import java.rmi.Remote;
043 import java.rmi.RemoteException;
044
045 /**
046 * RMI interface for obtaining an instance of an
047 * {@link RMIConnection}. An implementation of this
048 * interface exists for each RMI connector.
049 *
050 * @author Andrew John Hughes (gnu_andrew@member.fsf.org)
051 * @since 1.5
052 */
053 public interface RMIServer
054 extends Remote
055 {
056
057 /**
058 * Returns the version of the RMI connection protocol used
059 * by this server. The returned string takes the form of
060 * <emph>protocol-version implementation-name</emph> where
061 * <emph>protocol-version</emph> is a series of two or more
062 * non-negative integers, separated by a decimal point (.)
063 * (currently {@code 1.0}) and <emph>implementation-name</emph>
064 * is the string {@code "GNU Classpath"} followed by the version
065 * of GNU Classpath in use.
066 *
067 * @return the string specified above.
068 * @throws RemoteException if there is a problem with the transfer
069 * of the string via RMI.
070 */
071 String getVersion()
072 throws RemoteException;
073
074 /**
075 * Constructs and returns a new RMI connection using the specified
076 * authentication credentials. Each client calls this method to
077 * obtain a connection to the server.
078 *
079 * @param credentials a user-defined object passed to the server
080 * to authenticate the client. May be {@code null}.
081 * @return the new connection.
082 * @throws IOException if the new connection can not be created or
083 * exported, or an error occurs in the RMI transmission.
084 * @throws SecurityException if the client could not be authenticated
085 * correctly using the supplied credientials.
086 */
087 RMIConnection newClient(Object credentials)
088 throws IOException;
089 }