org.keycloak.models

## Interface AuthenticatedClientSessionModel

- All Superinterfaces:
    CommonClientSessionModel
  All Known Implementing Classes:
    AbstractAuthenticatedClientSessionModel, AuthenticatedClientSessionAdapter, MapAuthenticatedClientSessionAdapter, PersistentAuthenticatedClientSessionAdapter

      public interface AuthenticatedClientSessionModel
      extends CommonClientSessionModel

  Author:
    Marek Posolda

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Interface and Description
    --- | ---
    `static class` | `AuthenticatedClientSessionModel.SearchableFields`

    - ### Nested classes/interfaces inherited from interface org.keycloak.sessions.CommonClientSessionModel

      `CommonClientSessionModel.Action, CommonClientSessionModel.ExecutionStatus`

  - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `static String` | `STARTED_AT_NOTE`

  - ### Method Summary

    All Methods Instance Methods Abstract Methods Default Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `detachFromUserSession()` Detaches the client session from its user session.
    `String` | `getCurrentRefreshToken()`
    `int` | `getCurrentRefreshTokenUseCount()`
    `String` | `getId()`
    `String` | `getNote(String name)`
    `Map<String,String>` | `getNotes()`
    `default int` | `getStarted()`
    `int` | `getTimestamp()`
    `UserSessionModel` | `getUserSession()`
    `void` | `removeNote(String name)`
    `void` | `setCurrentRefreshToken(String currentRefreshToken)`
    `void` | `setCurrentRefreshTokenUseCount(int currentRefreshTokenUseCount)`
    `void` | `setNote(String name, String value)`
    `void` | `setTimestamp(int timestamp)`

    - ### Methods inherited from interface org.keycloak.sessions.CommonClientSessionModel

      `getAction, getClient, getProtocol, getRealm, getRedirectUri, setAction, setProtocol, setRedirectUri`

- - ### Field Detail

    - #### STARTED_AT_NOTE

          static final String STARTED_AT_NOTE

      See Also:
        Constant Field Values

  - ### Method Detail

    - #### getId

          String getId()

    - #### getStarted

          default int getStarted()

    - #### getTimestamp

          int getTimestamp()

    - #### setTimestamp

          void setTimestamp(int timestamp)

    - #### detachFromUserSession

          void detachFromUserSession()

      Detaches the client session from its user session.

    - #### getUserSession

          UserSessionModel getUserSession()

    - #### getCurrentRefreshToken

          String getCurrentRefreshToken()

    - #### setCurrentRefreshToken

          void setCurrentRefreshToken(String currentRefreshToken)

    - #### getCurrentRefreshTokenUseCount

          int getCurrentRefreshTokenUseCount()

    - #### setCurrentRefreshTokenUseCount

          void setCurrentRefreshTokenUseCount(int currentRefreshTokenUseCount)

    - #### getNote

          String getNote(String name)

    - #### setNote

          void setNote(String name,
                       String value)

    - #### removeNote

          void removeNote(String name)

    - #### getNotes

          Map<String,String> getNotes()

Copyright © 2021 JBoss by Red Hat. All rights reserved.