• root
• java
• j2se
• 1.6
• javax.management.remote.rmi
• RMIConnectorServer

Methods

• RMIConnectorServertop

  public RMIConnectorServer(JMXServiceURL url, Map<?> environment) throws IOException

  Makes an RMIConnectorServer. This is equivalent to calling RMIConnectorServer(directoryURL,environment,null,null)

  Parameters:

  @param url the URL defining how to create the connector server. Cannot be null.

  @param environment attributes governing the creation and storing of the RMI object. Can be null, which is equivalent to an empty Map.

  Exceptions:

  @exception IllegalArgumentException if url is null.

  @exception MalformedURLException if url does not conform to the syntax for an RMI connector, or if its protocol is not recognized by this implementation. Only "rmi" and "iiop" are valid when this constructor is used.

  @exception IOException if the connector server cannot be created for some reason or if it is inevitable that its start method will fail.

  Related Links:

  Google Code Search

  Stack Overflow

• RMIConnectorServertop

  public RMIConnectorServer(JMXServiceURL url, Map<?> environment, MBeanServer mbeanServer) throws IOException

  Makes an RMIConnectorServer for the given MBean server. This is equivalent to calling RMIConnectorServer(directoryURL,environment,null,mbeanServer)

  Parameters:

  @param url the URL defining how to create the connector server. Cannot be null.

  @param environment attributes governing the creation and storing of the RMI object. Can be null, which is equivalent to an empty Map.

  @param mbeanServer the MBean server to which the new connector server is attached, or null if it will be attached by being registered as an MBean in the MBean server.

  Exceptions:

  @exception IllegalArgumentException if url is null.

  @exception MalformedURLException if url does not conform to the syntax for an RMI connector, or if its protocol is not recognized by this implementation. Only "rmi" and "iiop" are valid when this constructor is used.

  @exception IOException if the connector server cannot be created for some reason or if it is inevitable that its start method will fail.

  Related Links:

  Google Code Search

  Stack Overflow

• RMIConnectorServertop

  public RMIConnectorServer(JMXServiceURL url, Map<?> environment, RMIServerImpl rmiServerImpl, MBeanServer mbeanServer) throws IOException

  Makes an RMIConnectorServer for the given MBean server.

  Parameters:

  @param url the URL defining how to create the connector server. Cannot be null.

  @param environment attributes governing the creation and storing of the RMI object. Can be null, which is equivalent to an empty Map.

  @param rmiServerImpl An implementation of the RMIServer interface, consistent with the protocol type specified in url. If this parameter is non null, the protocol type specified by url is not constrained, and is assumed to be valid. Otherwise, only "rmi" and "iiop" will be recognized.

  @param mbeanServer the MBean server to which the new connector server is attached, or null if it will be attached by being registered as an MBean in the MBean server.

  Exceptions:

  @exception IllegalArgumentException if url is null.

  @exception MalformedURLException if url does not conform to the syntax for an RMI connector, or if its protocol is not recognized by this implementation. Only "rmi" and "iiop" are recognized when rmiServerImpl is null.

  @exception IOException if the connector server cannot be created for some reason or if it is inevitable that its start method will fail.

  See:

  @see javax.management.remote.rmi.RMIConnectorServer.start()

  Related Links:

  Google Code Search

  Stack Overflow

• connectionClosedtop

  protected void connectionClosed(String connectionId, String message, Object userData)

  Called by a subclass when a client connection is closed normally. Removes connectionId from the list returned by javax.management.remote.JMXConnectorServer.getConnectionIds(), then emits a javax.management.remote.JMXConnectionNotification with type javax.management.remote.JMXConnectionNotification.CLOSED.

  Parameters:

  @param connectionId the ID of the closed connection.

  @param message the message for the emitted javax.management.remote.JMXConnectionNotification . Can be null. See javax.management.Notification.getMessage() .

  @param userData the userData for the emitted javax.management.remote.JMXConnectionNotification . Can be null. See javax.management.Notification.getUserData() .

  Override hierarchy:

  connectionClosed from JMXConnectorServer

  Related Links:

  Google Code Search

  Stack Overflow

• connectionFailedtop

  protected void connectionFailed(String connectionId, String message, Object userData)

  Called by a subclass when a client connection fails. Removes connectionId from the list returned by javax.management.remote.JMXConnectorServer.getConnectionIds(), then emits a javax.management.remote.JMXConnectionNotification with type javax.management.remote.JMXConnectionNotification.FAILED.

  Parameters:

  @param connectionId the ID of the failed connection.

  @param message the message for the emitted javax.management.remote.JMXConnectionNotification . Can be null. See javax.management.Notification.getMessage() .

  @param userData the userData for the emitted javax.management.remote.JMXConnectionNotification . Can be null. See javax.management.Notification.getUserData() .

  Override hierarchy:

  connectionFailed from JMXConnectorServer

  Related Links:

  Google Code Search

  Stack Overflow

• connectionOpenedtop

  protected void connectionOpened(String connectionId, String message, Object userData)

  Called by a subclass when a new client connection is opened. Adds connectionId to the list returned by javax.management.remote.JMXConnectorServer.getConnectionIds(), then emits a javax.management.remote.JMXConnectionNotification with type javax.management.remote.JMXConnectionNotification.OPENED.

  Parameters:

  @param connectionId the ID of the new connection. This must be different from the ID of any connection previously opened by this connector server.

  @param message the message for the emitted javax.management.remote.JMXConnectionNotification . Can be null. See javax.management.Notification.getMessage() .

  @param userData the userData for the emitted javax.management.remote.JMXConnectionNotification . Can be null. See javax.management.Notification.getUserData() .

  Override hierarchy:

  connectionOpened from JMXConnectorServer

  Related Links:

  Google Code Search

  Stack Overflow

• getAddresstop

  public JMXServiceURL getAddress()

  The address of this connector server.

  The address returned may not be the exact original javax.management.remote.JMXServiceURL that was supplied when creating the connector server, since the original address may not always be complete. For example the port number may be dynamically allocated when starting the connector server. Instead the address returned is the actual javax.management.remote.JMXServiceURL of the javax.management.remote.JMXConnectorServer. This is the address that clients supply to javax.management.remote.JMXConnectorFactory.connect(javax.management.remote.JMXServiceURL).

  Note that the address returned may be null if the JMXConnectorServer is not yet active.

  Return:

  @return the address of this connector server, or null if it does not have one.

  Specified by:

  getAddress from JMXConnectorServerMBean

  getAddress from JMXAddressable

  Related Links:

  Google Code Search

  Stack Overflow

• getAttributestop

  public Map<?> getAttributes()

  The attributes for this connector server.

  Return:

  @return a read-only map containing the attributes for this connector server. Attributes whose values are not serializable are omitted from this map. If there are no serializable attributes, the returned map is empty.

  Specified by:

  getAttributes from JMXConnectorServerMBean

  Related Links:

  Google Code Search

  Stack Overflow

• isActivetop

  public synchronized boolean isActive()

  Determines whether the connector server is active. A connector server starts being active when its start method returns successfully and remains active until either its stop method is called or the connector server fails.

  Return:

  @return true if the connector server is active.

  Specified by:

  isActive from JMXConnectorServerMBean

  Related Links:

  Google Code Search

  Stack Overflow

• setMBeanServerForwardertop

  public synchronized void setMBeanServerForwarder(MBeanServerForwarder mbsf)

  Adds an object that intercepts requests for the MBean server that arrive through this connector server. This object will be supplied as the MBeanServer for any new connection created by this connector server. Existing connections are unaffected.

  If this connector server is already associated with an MBeanServer object, then that object is given to mbsf.setMBeanServer. If doing so produces an exception, this method throws the same exception without any other effect.

  If this connector is not already associated with an MBeanServer object, or if the mbsf.setMBeanServer call just mentioned succeeds, then mbsf becomes this connector server's MBeanServer.

  Parameters:

  @param mbsf the new MBeanServerForwarder.

  Specified by:

  setMBeanServerForwarder from JMXConnectorServerMBean

  Override hierarchy:

  setMBeanServerForwarder from JMXConnectorServer

  Related Links:

  Google Code Search

  Stack Overflow

• starttop

  public synchronized void start() throws IOException

  Activates the connector server, that is starts listening for client connections. Calling this method when the connector server is already active has no effect. Calling this method when the connector server has been stopped will generate an IOException.

  The behavior of this method when called for the first time depends on the parameters that were supplied at construction, as described below.

  First, an object of a subclass of javax.management.remote.rmi.RMIServerImpl is required, to export the connector server through RMI:

  • If an RMIServerImpl was supplied to the constructor, it is used.
  • Otherwise, if the protocol part of the JMXServiceURL supplied to the constructor was iiop, an object of type javax.management.remote.rmi.RMIIIOPServerImpl is created.
  • Otherwise, if the JMXServiceURL was null, or its protocol part was rmi, an object of type javax.management.remote.rmi.RMIJRMPServerImpl is created.
  • Otherwise, the implementation can create an implementation-specific javax.management.remote.rmi.RMIServerImpl or it can throw java.net.MalformedURLException.

  If the given address includes a JNDI directory URL as specified in the package documentation for javax.management.remote.rmi, then this RMIConnectorServer will bootstrap by binding the RMIServerImpl to the given address.

  If the URL path part of the JMXServiceURL was empty or a single slash (/), then the RMI object will not be bound to a directory. Instead, a reference to it will be encoded in the URL path of the RMIConnectorServer address (returned by javax.management.remote.rmi.RMIConnectorServer.getAddress()). The encodings for rmi and iiop are described in the package documentation for javax.management.remote.rmi.

  The behavior when the URL path is neither empty nor a JNDI directory URL, or when the protocol is neither rmi nor iiop, is implementation defined, and may include throwing java.net.MalformedURLException when the connector server is created or when it is started.

  Exceptions:

  @exception IllegalStateException if the connector server has not been attached to an MBean server.

  @exception IOException if the connector server cannot be started.

  Specified by:

  start from JMXConnectorServerMBean

  Related Links:

  Google Code Search

  Stack Overflow

• stoptop

  public void stop() throws IOException

  Deactivates the connector server, that is, stops listening for client connections. Calling this method will also close all client connections that were made by this server. After this method returns, whether normally or with an exception, the connector server will not create any new client connections.

  Once a connector server has been stopped, it cannot be started again.

  Calling this method when the connector server has already been stopped has no effect. Calling this method when the connector server has not yet been started will disable the connector server object permanently.

  If closing a client connection produces an exception, that exception is not thrown from this method. A javax.management.remote.JMXConnectionNotification is emitted from this MBean with the connection ID of the connection that could not be closed.

  Closing a connector server is a potentially slow operation. For example, if a client machine with an open connection has crashed, the close operation might have to wait for a network protocol timeout. Callers that do not want to block in a close operation should do it in a separate thread.

  This method calls the method close on the connector server's RMIServerImpl object.

  If the RMIServerImpl was bound to a JNDI directory by the start method, it is unbound from the directory by this method.

  Exceptions:

  @exception IOException if the server cannot be closed cleanly, or if the RMIServerImpl cannot be unbound from the directory. When this exception is thrown, the server has already attempted to close all client connections, if appropriate; to call javax.management.remote.rmi.RMIServerImpl.close() ; and to unbind the RMIServerImpl from its directory, if appropriate. All client connections are closed except possibly those that generated exceptions when the server attempted to close them.

  Specified by:

  stop from JMXConnectorServerMBean

  Related Links:

  Google Code Search

  Stack Overflow

• toJMXConnectortop

  public JMXConnector toJMXConnector(Map<?> env) throws IOException

  Returns a client stub for this connector server. A client stub is a serializable object whose connect method can be used to make one new connection to this connector server.

  Parameters:

  @param env client connection parameters of the same sort that could be provided to JMXConnector.connect(Map) . Can be null, which is equivalent to an empty map.

  Return:

  @return a client stub that can be used to make a new connection to this connector server.

  Exceptions:

  @exception UnsupportedOperationException if this connector server does not support the generation of client stubs.

  @exception IllegalStateException if the JMXConnectorServer is not started (see javax.management.remote.rmi.RMIConnectorServer.isActive() ).

  @exception IOException if a communications problem means that a stub cannot be created.

  Specified by:

  toJMXConnector from JMXConnectorServerMBean

  Override hierarchy:

  toJMXConnector from JMXConnectorServer

  Related Links:

  Google Code Search

  Stack Overflow