クラス NimbusJwtEncoder
java.lang.ObjectSE
org.springframework.security.oauth2.jwt.NimbusJwtEncoder
- 実装されているすべてのインターフェース:
JwtEncoder
JSON Web 署名(JWS)コンパクト直列化形式を使用して JSON Web トークン(JWT)をエンコードする
JwtEncoder の実装。JWS の署名に使用される秘密鍵 / 秘密鍵は、コンストラクターを介して提供される com.nimbusds.jose.jwk.source.JWKSource によって提供されます。注意 : この実装では、Nimbus JOSE + JWTSDK を使用します。
- 導入:
- 5.6
- 関連事項:
ネストされたクラスの要約
ネストされたクラス修飾子と型クラス説明static final classstatic final classKeyPairSE で構成されたNimbusJwtEncoderインスタンスを作成するためのビルダー。static final classSecretKeySE で構成されたNimbusJwtEncoderインスタンスを作成するためのビルダー。コンストラクターの概要
コンストラクターコンストラクター説明NimbusJwtEncoder(com.nimbusds.jose.jwk.source.JWKSource<com.nimbusds.jose.proc.SecurityContext> jwkSource) 指定されたパラメーターを使用してNimbusJwtEncoderを構築します。メソッドのサマリー
修飾子と型メソッド説明encode(JwtEncoderParameters parameters) JWT をコンパクトなクレーム表現形式にエンコードします。voidsetJwkSelector(org.springframework.core.convert.converter.Converter<ListSE<com.nimbusds.jose.jwk.JWK>, com.nimbusds.jose.jwk.JWK> jwkSelector) 一致する JWK が複数ある場合に、この戦略を使用してリストを減らします。withKeyPair(ECPublicKeySE publicKey, ECPrivateKeySE privateKey) 提供されたNimbusJwtEncoderを構築するためのビルダーを作成しますwithKeyPair(RSAPublicKeySE publicKey, RSAPrivateKeySE privateKey) 提供されたNimbusJwtEncoderを構築するためのビルダーを作成しますwithSecretKey(SecretKeySE secretKey) 提供されたNimbusJwtEncoderを構築するためのビルダーを作成します
コンストラクターの詳細
NimbusJwtEncoder
public NimbusJwtEncoder(com.nimbusds.jose.jwk.source.JWKSource<com.nimbusds.jose.proc.SecurityContext> jwkSource) 指定されたパラメーターを使用してNimbusJwtEncoderを構築します。- パラメーター:
jwkSource-com.nimbusds.jose.jwk.source.JWKSource
メソッドの詳細
setJwkSelector
public void setJwkSelector(org.springframework.core.convert.converter.Converter<ListSE<com.nimbusds.jose.jwk.JWK>, com.nimbusds.jose.jwk.JWK> jwkSelector) 一致する JWK が複数ある場合に、この戦略を使用してリストを減らします。たとえば、このエンコーダーに最初の一致を選択させるには、
setJwkSelector(List::getFirst)を呼び出すことができます。デフォルトでは、クラスは例外をスローします。
- 導入:
- 6.5
encode
インターフェースからコピーされた説明:JwtEncoderJWT をコンパクトなクレーム表現形式にエンコードします。- 次で指定:
- インターフェース
JwtEncoderのencode - パラメーター:
parameters- JOSE ヘッダーと JWT クレームセットを含むパラメーター- 戻り値:
Jwt- 例外:
JwtEncodingException- JWT のエンコード中にエラーが発生した場合
withKeyPair
public static NimbusJwtEncoder.RsaKeyPairJwtEncoderBuilder withKeyPair(RSAPublicKeySE publicKey, RSAPrivateKeySE privateKey) 提供されたNimbusJwtEncoderを構築するためのビルダーを作成します- パラメーター:
publicKey- JWT の署名に使用するRSAPublicKeySE と @Param、privateKey、RSAPrivateKeySE- 戻り値:
NimbusJwtEncoder.RsaKeyPairJwtEncoderBuilder- 導入:
- 7.0
withKeyPair
public static NimbusJwtEncoder.EcKeyPairJwtEncoderBuilder withKeyPair(ECPublicKeySE publicKey, ECPrivateKeySE privateKey) 提供されたNimbusJwtEncoderを構築するためのビルダーを作成します- パラメーター:
publicKey- JWT の署名に使用するECPublicKeySE と @param、privateKey、ECPrivateKeySE- 戻り値:
NimbusJwtEncoder.EcKeyPairJwtEncoderBuilder- 導入:
- 7.0
withSecretKey
提供されたNimbusJwtEncoderを構築するためのビルダーを作成します- パラメーター:
secretKey-- 戻り値:
JWKを構成するためのNimbusJwtEncoder.SecretKeyJwtEncoderBuilder- 導入:
- 7.0