JMXConnectorServerProvider


1   /*
2    * @(#)JMXConnectorServerProvider.java  1.6 04/05/05
3    * 
4    * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
5    * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
6    */
7   
8   package javax.management.remote;
9   
10  import java.io.IOException  ;
11  import java.util.Map  ;
12  
13  import javax.management.MBeanServer  ;
14  
15  /**
16   * <p>A provider for creating JMX API connector servers using a given
17   * protocol.  Instances of this interface are created by {@link
18   * JMXConnectorServerFactory} as part of its {@link
19   * JMXConnectorServerFactory#newJMXConnectorServer(JMXServiceURL,Map,MBeanServer)
20   * newJMXConnectorServer} method.</p>
21   *
22   * @since 1.5
23   * @since.unbundled 1.0
24   */
25  public interface JMXConnectorServerProvider {
26      /**
27       * <p>Creates a new connector server at the given address.  Each
28       * successful call to this method produces a different
29       * <code>JMXConnectorServer</code> object.</p>
30       *
31       * @param serviceURL the address of the new connector server.  The
32       * actual address of the new connector server, as returned by its
33       * {@link JMXConnectorServer#getAddress() getAddress} method, will
34       * not necessarily be exactly the same.  For example, it might
35       * include a port number if the original address did not.
36       *
37       * @param environment a read-only Map containing named attributes
38       * to control the new connector server's behaviour.  Keys in this
39       * map must be Strings.  The appropriate type of each associated
40       * value depends on the attribute.
41       *
42       * @param mbeanServer the MBean server that this connector server
43       * is attached to.  Null if this connector server will be attached
44       * to an MBean server by being registered in it.
45       *
46       * @return a <code>JMXConnectorServer</code> representing the new
47       * connector server.  Each successful call to this method produces
48       * a different object.
49       *
50       * @exception NullPointerException if <code>serviceURL</code> or
51       * <code>environment</code> is null.
52       *
53       * @exception IOException if the connector server cannot be
54       * created.
55       */
56      public JMXConnectorServer   newJMXConnectorServer(JMXServiceURL   serviceURL,
57                              Map  <String  ,?> environment,
58                              MBeanServer   mbeanServer)
59          throws IOException  ;
60  }
61
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags