Interface Client

All Superinterfaces:
Endpoint

public interface Client
extends Endpoint
The Client interface allows to get information about a connected client's socket address, type and UUID.
See Also:
ClientService, ClientListener
  • Method Summary

    Modifier and Type Method Description
    String getClientType()
    Type could be a client type from ConnectionType or it can be a custom client implementation with a name outside of this @{link ConnectionType}
    Set<String> getLabels()  
    String getName()
    This method may return null depending on the client version and the client type Java client provides client name starting with 3.12
    InetSocketAddress getSocketAddress()
    Returns the socket address of this client.
    UUID getUuid()
    Returns a unique UUID for this client.
  • Method Details

    • getUuid

      UUID getUuid()
      Returns a unique UUID for this client.
      Specified by:
      getUuid in interface Endpoint
      Returns:
      a unique UUID for this client
    • getSocketAddress

      InetSocketAddress getSocketAddress()
      Returns the socket address of this client.
      Specified by:
      getSocketAddress in interface Endpoint
      Returns:
      the socket address of this client
    • getClientType

      String getClientType()
      Type could be a client type from ConnectionType or it can be a custom client implementation with a name outside of this @{link ConnectionType}
      Returns:
      the type of this client
    • getName

      String getName()
      This method may return null depending on the client version and the client type Java client provides client name starting with 3.12
      Returns:
      the name of this client if provided, null otherwise
      Since:
      3.12
    • getLabels

      Set<String> getLabels()
      Returns:
      read only set of all labels of this client.
      Since:
      3.12