org.springframework.messaging.simp.user

## Interface SimpUser

-     public interface SimpUser

  Represents a connected user.
  Since:
    4.2
  Author:
    Rossen Stoyanchev

- - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getName()` The unique user name.
    `Principal` | `getPrincipal()` Return the user associated with the session, if available.
    `SimpSession` | `getSession(String sessionId)` Look up the session for the given id.
    `Set<SimpSession>` | `getSessions()` Return the sessions for the user.
    `boolean` | `hasSessions()` Whether the user has any sessions.

- - ### Method Detail

    - #### getName

          String getName()

      The unique user name.

    - #### getPrincipal

          @Nullable
          Principal getPrincipal()

      Return the user associated with the session, if available. Typically, the user information is available unless the user is connected to a different server in a multi-server user registry scenario.
      Since:
        5.3

    - #### hasSessions

          boolean hasSessions()

      Whether the user has any sessions.

    - #### getSession

          @Nullable
          SimpSession getSession(String sessionId)

      Look up the session for the given id.
      Parameters:
        `sessionId` - the session id
      Returns:
        the matching session, or `null` if none found

    - #### getSessions

          Set<SimpSession> getSessions()

      Return the sessions for the user. The returned set is a copy and will never be modified.
      Returns:
        a set of session ids, or an empty set if none