インターフェース JwtClaims

  • すべてのスーパーインターフェース:
    Claims

    public interface JwtClaims
    extends Claims
    標準の JWT クレーム。通常はトークン。
    • フィールドの詳細

      • NONE

        static final JwtClaims NONE
        クレームがないことを表すシングルトンインスタンス
    • メソッドの詳細

      • getIssuer

        default OptionalSE<StringSE> getIssuer()
        JWT を発行したプリンシパル
        戻り値:
        iss クレームの値
      • getSubject

        default OptionalSE<StringSE> getSubject()
        JWT のサブジェクトであるプリンシパル。JWT 内のクレームは通常、サブジェクトに関するステートメントです。
        戻り値:
        sub クレームの値
      • getAudience

        default ListSE<StringSE> getAudience()
        JWT が対象とする受信者。フィールドでの作業を容易にするために、オーディエンスは常にリストとして表されます。特殊な場合も同様です。トークン内の文字列である場合はシングルトンリストであり、存在しない場合は空のセットになります。
        戻り値:
        aud クレームの値を表す null 以外のセット
      • getExpirationTime

        default OptionalSE<InstantSE> getExpirationTime()
        有効期限以降は JWT の処理を受け入れてはなりません (MUST NOT)。
        戻り値:
        exp クレームの値
      • isExpired

        default boolean isExpired​(ClockSE clock,
                                  boolean required,
                                  DurationSE skew)
        JWT の有効期限が切れているかどうかを確認する
        パラメーター:
        clock - 検査の基準時刻を表す監視
        required - クレームが必要かどうかを示す。e. クレームのあるトークンが期限切れとみなされるかどうか
        skew - プロバイダーと当社の間のドリフトを考慮して許容されるクロックスキュー
        戻り値:
        現在時刻が有効期限を過ぎている場合、または exp 要求が存在せず、required が true である場合は true
      • getNotBeforeTime

        default OptionalSE<InstantSE> getNotBeforeTime()
        この時間より前は JWT の処理を受け入れてはなりません。
        戻り値:
      • isBeforeValidity

        default boolean isBeforeValidity​(ClockSE clock,
                                         boolean required,
                                         DurationSE skew)
        JWT が定義された有効期限より前であるかどうかを確認する
        パラメーター:
        clock - 検査の基準時刻を表す監視
        required - クレームが必要かどうかの表示、i. e. nbf のないトークンが有効性の前に考慮されるかどうか
        skew - プロバイダーと当社の間のドリフトを考慮して許容されるクロックスキュー
        戻り値:
      • isValid

        default boolean isValid()
        1MIN クロックスキューで現在時刻に対して JWT の有効性をチェックします。
        戻り値:
        exp トークンが存在し制限内にあり、nbf が存在する場合は制限内にある場合は true
      • getIssuedAt

        default OptionalSE<InstantSE> getIssuedAt()
        JWT が発行された時刻。
        戻り値:
        exp クレームの値
      • getJwtId

        default OptionalSE<StringSE> getJwtId()
        JWT の一意の識別子
        戻り値:
        jti クレームの値