インターフェース JwtEncoder
- すべての既知の実装クラス:
NimbusJwtEncoder
- 関数インターフェース:
- これは関数インターフェースであるため、ラムダ式またはメソッド参照の割り当てターゲットとして使用できます。
@FunctionalInterface public interface JwtEncoder
このインターフェースの実装は、JSON Web トークン(JWT)をコンパクトなクレーム表現形式にエンコードするロールを果たします。JWT は、JSON Web 署名(JWS)構造の場合は JWS コンパクト直列化形式を使用して、JSON Web 暗号化(JWE)構造の場合は JWE コンパクト直列化形式を使用して表すことができます。実装者は JWS への署名および / または JWE の暗号化に責任があります。
- 導入:
- 5.6
- 関連事項:
Jwt
,JwtEncoderParameters
,JwtDecoder
, JSON Web トークン (JWT) , JSON Web 署名 (JWS) , JSON Web 暗号化 (JWE) , JWS コンパクト直列化 , JWE コンパクト直列化
メソッドのサマリー
すべてのメソッド インスタンスメソッド 抽象メソッド 修飾子と型 メソッド 説明 Jwt
encode(JwtEncoderParameters parameters)
JWT をコンパクトなクレーム表現形式にエンコードします。
メソッドの詳細
encode
Jwt encode(JwtEncoderParameters parameters) throws JwtEncodingException
JWT をコンパクトなクレーム表現形式にエンコードします。- パラメーター:
parameters
- JOSE ヘッダーと JWT クレームセットを含むパラメーター- 戻り値:
Jwt
- 例外:
JwtEncodingException
- JWT のエンコード中にエラーが発生した場合