01 /*
02 * Copyright 2002-2007 Sun Microsystems, Inc. All Rights Reserved.
03 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04 *
05 * This code is free software; you can redistribute it and/or modify it
06 * under the terms of the GNU General Public License version 2 only, as
07 * published by the Free Software Foundation. Sun designates this
08 * particular file as subject to the "Classpath" exception as provided
09 * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26 package javax.management.remote;
27
28 import java.io.IOException;
29 import java.util.Map;
30
31 /**
32 * <p>A provider for creating JMX API connector clients using a given
33 * protocol. Instances of this interface are created by {@link
34 * JMXConnectorFactory} as part of its {@link
35 * JMXConnectorFactory#newJMXConnector(JMXServiceURL, Map)
36 * newJMXConnector} method.</p>
37 *
38 * @since 1.5
39 */
40 public interface JMXConnectorProvider {
41 /**
42 * <p>Creates a new connector client that is ready to connect
43 * to the connector server at the given address. Each successful
44 * call to this method produces a different
45 * <code>JMXConnector</code> object.</p>
46 *
47 * @param serviceURL the address of the connector server to connect to.
48 *
49 * @param environment a read-only Map containing named attributes
50 * to determine how the connection is made. Keys in this map must
51 * be Strings. The appropriate type of each associated value
52 * depends on the attribute.</p>
53 *
54 * @return a <code>JMXConnector</code> representing the new
55 * connector client. Each successful call to this method produces
56 * a different object.
57 *
58 * @exception NullPointerException if <code>serviceURL</code> or
59 * <code>environment</code> is null.
60 *
61 * @exception IOException It is recommended for a provider
62 * implementation to throw {@code MalformedURLException} if the
63 * protocol in the {@code serviceURL} is not recognized by this
64 * provider, {@code JMXProviderException} if this is a provider
65 * for the protocol in {@code serviceURL} but it cannot be used
66 * for some reason or any other {@code IOException} if the
67 * connection cannot be made because of a communication problem.
68 */
69 public JMXConnector newJMXConnector(JMXServiceURL serviceURL,
70 Map<String, ?> environment) throws IOException;
71 }
|