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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.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}
      java.util.Set<java.lang.String> getLabels()  
      java.lang.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
      java.net.InetSocketAddress getSocketAddress()
      Returns the socket address of this client.
      java.util.UUID getUuid()
      Returns a unique UUID for this client.
    • Method Detail

      • getUuid

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

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

        java.lang.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

        java.lang.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

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