1 /*

     2  * Copyright 2002-2007 Sun Microsystems, Inc.  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.  Sun designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * 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 

    27 package javax.management.remote;

    28 

    29 import java.io.IOException;

    30 import java.util.Map;

    31 

    32 /**

    33  * <p>A provider for creating JMX API connector clients using a given

    34  * protocol.  Instances of this interface are created by {@link

    35  * JMXConnectorFactory} as part of its {@link

    36  * JMXConnectorFactory#newJMXConnector(JMXServiceURL, Map)

    37  * newJMXConnector} method.</p>

    38  *

    39  * @since 1.5

    40  */

    41 public interface JMXConnectorProvider {

    42     /**

    43      * <p>Creates a new connector client that is ready to connect

    44      * to the connector server at the given address.  Each successful

    45      * call to this method produces a different

    46      * <code>JMXConnector</code> object.</p>

    47      *

    48      * @param serviceURL the address of the connector server to connect to.

    49      *

    50      * @param environment a read-only Map containing named attributes

    51      * to determine how the connection is made.  Keys in this map must

    52      * be Strings.  The appropriate type of each associated value

    53      * depends on the attribute.</p>

    54      *

    55      * @return a <code>JMXConnector</code> representing the new

    56      * connector client.  Each successful call to this method produces

    57      * a different object.

    58      *

    59      * @exception NullPointerException if <code>serviceURL</code> or

    60      * <code>environment</code> is null.

    61      *

    62      * @exception IOException It is recommended for a provider

    63      * implementation to throw {@code MalformedURLException} if the

    64      * protocol in the {@code serviceURL} is not recognized by this

    65      * provider, {@code JMXProviderException} if this is a provider

    66      * for the protocol in {@code serviceURL} but it cannot be used

    67      * for some reason or any other {@code IOException} if the

    68      * connection cannot be made because of a communication problem.

    69      */

    70     public JMXConnector newJMXConnector(JMXServiceURL serviceURL,

    71                                         Map<String,?> environment)

    72             throws IOException;

    73 }