インターフェース Session

すべての既知の実装クラス:
MapSessionReactiveRedisIndexedSessionRepository.RedisSession

public interface Session
不可知論的な方法でユーザーを識別する方法を提供します。これにより、セッションを HttpSession、WebSocket セッション、Web に関連しないセッションで使用できるようになります。
導入:
1.0
  • メソッドの詳細

    • getId

      StringSE getId()
      Session を識別する一意の文字列を取得します。
      戻り値:
      Session を識別する一意の文字列
    • changeSessionId

      StringSE changeSessionId()
      セッション ID を変更します。getId() を呼び出した後、新しい識別子が返されます。
      戻り値:
      getId() が返す新しいセッション ID
    • getAttribute

      <T> T getAttribute(StringSE attributeName)
      指定された名前に関連付けられているオブジェクトを取得します。その名前に関連付けられているオブジェクトがない場合は null を取得します。
      型パラメーター:
      T - 属性の戻り値の型
      パラメーター:
      attributeName - 取得する属性の名前
      戻り値:
      指定された名前に関連付けられているオブジェクト。その名前に関連付けられているオブジェクトがない場合は null
    • getRequiredAttribute

      default <T> T getRequiredAttribute(StringSE name)
      セッション属性値を返すか、存在しない場合は IllegalArgumentExceptionSE を発生させます。
      型パラメーター:
      T - 属性型
      パラメーター:
      name - 属性名
      戻り値:
      属性値
    • getAttributeOrDefault

      default <T> T getAttributeOrDefault(StringSE name, T defaultValue)
      セッション属性値、またはデフォルトのフォールバック値を返します。
      型パラメーター:
      T - 属性型
      パラメーター:
      name - 属性名
      defaultValue - 代わりに返すデフォルト値
      戻り値:
      属性値
    • getAttributeNames

      SetSE<StringSE> getAttributeNames()
      値が関連付けられている属性名を取得します。各値を getAttribute(String) に渡して、属性値を取得できます。
      戻り値:
      値が関連付けられている属性名。
      関連事項:
    • setAttribute

      void setAttribute(StringSE attributeName, ObjectSE attributeValue)
      指定された属性名の属性値を設定します。attributeValue が null の場合、removeAttribute(String) で属性を削除した場合と同じ結果になります。
      パラメーター:
      attributeName - 設定する属性名
      attributeValue - 設定する属性の値。null の場合、属性は削除されます。
    • removeAttribute

      void removeAttribute(StringSE attributeName)
      指定された属性名を持つ属性を削除します。
      パラメーター:
      attributeName - 削除する属性の名前
    • getCreationTime

      InstantSE getCreationTime()
      このセッションが作成された時刻を取得します。
      戻り値:
      このセッションが作成された時刻。
    • setLastAccessedTime

      void setLastAccessedTime(InstantSE lastAccessedTime)
      最終アクセス時間を設定します。
      パラメーター:
      lastAccessedTime - 最終アクセス時間
    • getLastAccessedTime

      InstantSE getLastAccessedTime()
      この Session が最後にアクセスされた時刻を取得します。
      戻り値:
      クライアントがセッションに関連付けられたリクエストを最後に送信したとき
    • setMaxInactiveInterval

      void setMaxInactiveInterval(DurationSE interval)
      このセッションが無効になるまでのリクエスト間の最大非アクティブ間隔を設定します。負の時間は、セッションがタイムアウトしないことを示します。
      パラメーター:
      interval - クライアントリクエスト間で Session を存続させる必要がある時間。
    • getMaxInactiveInterval

      DurationSE getMaxInactiveInterval()
      このセッションが無効になるまでのリクエスト間の最大非アクティブ間隔を取得します。負の時間は、セッションがタイムアウトしないことを示します。
      戻り値:
      このセッションが無効になるまでのリクエスト間の最大非アクティブ間隔。負の時間は、セッションがタイムアウトしないことを示します。
    • isExpired

      boolean isExpired()
      セッションの有効期限が切れている場合は true を返します。
      戻り値:
      セッションの有効期限が切れている場合は true、それ以外の場合は false。