Package org.opends.server.protocols.jmx

Class JmxClientConnection

java.lang.Object
org.opends.server.api.ClientConnection
org.opends.server.protocols.jmx.JmxClientConnection
All Implemented Interfaces:
EventListener, NotificationListener
public final class JmxClientConnection extends ClientConnection implements NotificationListener
This class defines the set of methods and structures that must be implemented by a Directory Server client connection.

  • Method Details

    • handleNotification

      public void handleNotification(Notification notif, Object handback)
      Specified by:
      handleNotification in interface NotificationListener

    • getConnectionID

      public long getConnectionID()
      Description copied from class: ClientConnection
      Retrieves the unique identifier that has been assigned to this connection.
      Specified by:
      getConnectionID in class ClientConnection
      Returns:
      The unique identifier that has been assigned to this connection.

    • getConnectionHandler

      public ConnectionHandler<?> getConnectionHandler()
      Description copied from class: ClientConnection
      Retrieves the connection handler that accepted this client connection.
      Specified by:
      getConnectionHandler in class ClientConnection
      Returns:
      The connection handler that accepted this client connection.

    • getProtocol

      public String getProtocol()
      Description copied from class: ClientConnection
      Retrieves the protocol that the client is using to communicate with the Directory Server.
      Specified by:
      getProtocol in class ClientConnection
      Returns:
      The protocol that the client is using to communicate with the Directory Server.

    • getClientAddress

      public String getClientAddress()
      Description copied from class: ClientConnection
      Retrieves a string representation of the address of the client.
      Specified by:
      getClientAddress in class ClientConnection
      Returns:
      A string representation of the address of the client.

    • getClientPort

      public int getClientPort()
      Description copied from class: ClientConnection
      Retrieves the port number for this connection on the client system if available.
      Specified by:
      getClientPort in class ClientConnection
      Returns:
      The port number for this connection on the client system or -1 if there is no client port associated with this connection (e.g. internal client).

    • getServerAddress

      public String getServerAddress()
      Description copied from class: ClientConnection
      Retrieves a string representation of the address on the server to which the client connected.
      Specified by:
      getServerAddress in class ClientConnection
      Returns:
      A string representation of the address on the server to which the client connected.

    • getServerPort

      public int getServerPort()
      Description copied from class: ClientConnection
      Retrieves the port number for this connection on the server system if available.
      Specified by:
      getServerPort in class ClientConnection
      Returns:
      The port number for this connection on the server system or -1 if there is no server port associated with this connection (e.g. internal client).

    • getRemoteAddress

      public InetAddress getRemoteAddress()
      Description copied from class: ClientConnection
      Retrieves the InetAddress associated with the remote client system.
      Specified by:
      getRemoteAddress in class ClientConnection
      Returns:
      The InetAddress associated with the remote client system. It may be null if the client is not connected over an IP-based connection.

    • isConnectionValid

      public boolean isConnectionValid()
      Description copied from class: ClientConnection
      Returns whether the Directory Server believes this connection to be valid and available for communication.
      Specified by:
      isConnectionValid in class ClientConnection
      Returns:
      true if the connection is valid, false otherwise

    • isSecure

      public boolean isSecure()
      Description copied from class: ClientConnection
      Indicates whether this client connection is currently using a secure mechanism to communicate with the server. Note that this may change over time based on operations performed by the client or server (e.g., it may go from false to true if the client uses the StartTLS extended operation).
      Specified by:
      isSecure in class ClientConnection
      Returns:
      true if the client connection is currently using a secure mechanism to communicate with the server, or false if not.

    • disconnect

      public void disconnect(DisconnectReason disconnectReason, boolean sendNotification, LocalizableMessage message)
      Description copied from class: ClientConnection
      Asynchronously closes the connection to the client, optionally sending it a message indicating the reason for the closure. Note that the ability to send a notice of disconnection may not be available for all protocols or under all circumstances.

      All subclasses must invoke the finalizeConnectionInternal method during the course of processing this method. In addition, implementations should not block until active requests are cancelled due to the risk of deadlocks in cases where a request attempts to disconnect its own connection (e.g. when deleting the authenticated user).

      Specified by:
      disconnect in class ClientConnection
      Parameters:
      disconnectReason - The disconnect reason that provides the generic cause for the disconnect.
      sendNotification - Indicates whether to try to provide notification to the client that the connection will be closed.
      message - The message to send to the client. It may be null if no notification is to be sent.

    • getMonitorSummary

      public JsonValue getMonitorSummary()
      Description copied from class: ClientConnection
      Returns a summary of this client connection in JSON (format that is both human readable and machine parseable).
      Specified by:
      getMonitorSummary in class ClientConnection
      Returns:
      A summary of this client connection in JSON.

    • toString

      public void toString(StringBuilder buffer)
      Description copied from class: ClientConnection
      Appends a string representation of this client connection to the provided buffer.
      Specified by:
      toString in class ClientConnection
      Parameters:
      buffer - The buffer to which the information should be appended.

    • finalize

      protected void finalize()
      Called by the Gc when the object is garbage collected Release the cursor in case the iterator was badly used and releaseCursor was never called.
      Overrides:
      finalize in class Object

    • getSSF

      public int getSSF()
      Description copied from class: ClientConnection
      Return the Security Strength Factor of a client connection.
      Specified by:
      getSSF in class ClientConnection
      Returns:
      An integer representing the SSF value of a connection.