クラス RelyingPartyRegistration.Builder
- java.lang.Object
-
- org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration.Builder
- 含まれているクラス:
- RelyingPartyRegistration
public static final class RelyingPartyRegistration.Builder extends java.lang.Object
メソッドのサマリー
メソッドの詳細
registrationId
public RelyingPartyRegistration.Builder registrationId(java.lang.String id)
registrationId
テンプレートを設定します。多くの場合、URL パスで使用されます- パラメーター:
id
- このオブジェクトの registrationId は一意である必要があります- 戻り値:
- このオブジェクト
entityId
public RelyingPartyRegistration.Builder entityId(java.lang.String entityId)
証明書利用者の EntityID を設定します。証明書利用者の <EntityDescriptor EntityID = "..." /> にある値に相当します。この値には、いくつかのプレースホルダーが含まれる場合があります。それらはbaseUrl
、registrationId
、baseScheme
、baseHost
、basePort
です。- パラメーター:
entityId
- 依存パーティの EntityID- 戻り値:
- さらなる構成のための
RelyingPartyRegistration.Builder
- 導入:
- 5.4
signingX509Credentials
public RelyingPartyRegistration.Builder signingX509Credentials(java.util.function.Consumer<java.util.Collection<Saml2X509Credential>> credentialsConsumer)
- パラメーター:
credentialsConsumer
- -Collection
を変更するためのConsumer
- 戻り値:
- さらなる構成のための
RelyingPartyRegistration.Builder
- 導入:
- 5.4
decryptionX509Credentials
public RelyingPartyRegistration.Builder decryptionX509Credentials(java.util.function.Consumer<java.util.Collection<Saml2X509Credential>> credentialsConsumer)
- パラメーター:
credentialsConsumer
- -Collection
を変更するためのConsumer
- 戻り値:
- さらなる構成のための
RelyingPartyRegistration.Builder
- 導入:
- 5.4
assertionConsumerServiceLocation
public RelyingPartyRegistration.Builder assertionConsumerServiceLocation(java.lang.String assertionConsumerServiceLocation)
AssertionConsumerService の場所を設定します。証明書利用者の <SPSSODescriptor> の <AssertionConsumerService Location="..." /> にある値に相当します
この値には、いくつかのプレースホルダーが含まれる場合があります。それらは
baseUrl
、registrationId
、baseScheme
、baseHost
、basePort
です。- パラメーター:
assertionConsumerServiceLocation
- AssertionConsumerService の場所- 戻り値:
- さらなる構成のための
RelyingPartyRegistration.Builder
- 導入:
- 5.4
assertionConsumerServiceBinding
public RelyingPartyRegistration.Builder assertionConsumerServiceBinding(Saml2MessageBinding assertionConsumerServiceBinding)
AssertionConsumerService バインディングを設定します。証明書利用者の <SPSSODescriptor> の <AssertionConsumerService Binding="..." /> にある値に相当します
- パラメーター:
assertionConsumerServiceBinding
- AssertionConsumerService バインディング- 戻り値:
- さらなる構成のための
RelyingPartyRegistration.Builder
- 導入:
- 5.4
singleLogoutServiceBinding
public RelyingPartyRegistration.Builder singleLogoutServiceBinding(Saml2MessageBinding singleLogoutServiceBinding)
SingleLogoutService バインディングを設定する証明書利用者の <SPSSODescriptor> の <SingleLogoutService Binding="..." /> にある値に相当します。
- パラメーター:
singleLogoutServiceBinding
- SingleLogoutService バインディング- 戻り値:
- さらなる構成のための
RelyingPartyRegistration.Builder
- 導入:
- 5.6
singleLogoutServiceLocation
public RelyingPartyRegistration.Builder singleLogoutServiceLocation(java.lang.String singleLogoutServiceLocation)
SingleLogoutService の場所を設定する証明書利用者の <SPSSODescriptor> の <SingleLogoutService Location="..." /> にある値に相当します。
- パラメーター:
singleLogoutServiceLocation
- SingleLogoutService ロケーション- 戻り値:
- さらなる構成のための
RelyingPartyRegistration.Builder
- 導入:
- 5.6
singleLogoutServiceResponseLocation
public RelyingPartyRegistration.Builder singleLogoutServiceResponseLocation(java.lang.String singleLogoutServiceResponseLocation)
SingleLogoutService レスポンス場所を設定する証明書利用者の <SPSSODescriptor> の <SingleLogoutService ResponseLocation="..." /> にある値に相当します。
- パラメーター:
singleLogoutServiceResponseLocation
- SingleLogoutService レスポンス位置- 戻り値:
- さらなる構成のための
RelyingPartyRegistration.Builder
- 導入:
- 5.6
nameIdFormat
public RelyingPartyRegistration.Builder nameIdFormat(java.lang.String nameIdFormat)
NameID 形式を設定します- パラメーター:
nameIdFormat
-- 戻り値:
- さらなる構成のための
RelyingPartyRegistration.Builder
- 導入:
- 5.7
assertingPartyDetails
public RelyingPartyRegistration.Builder assertingPartyDetails(java.util.function.Consumer<RelyingPartyRegistration.AssertingPartyDetails.Builder> assertingPartyDetails)
このConsumer
を適用して、アサーティングパーティの詳細をさらに構成します- パラメーター:
assertingPartyDetails
- 適用するConsumer
- 戻り値:
- さらなる構成のための
RelyingPartyRegistration.Builder
- 導入:
- 5.4
credentials
@Deprecated public RelyingPartyRegistration.Builder credentials(java.util.function.Consumer<java.util.Collection<Saml2X509Credential>> credentials)
使用すべきではありません。IDP と SP 間の通信で使用されるSaml2X509Credential
オブジェクトのコレクションを変更します。例:Saml2X509Credential credential =...; return RelyingPartyRegistration.withRegistrationId("id") .credentials((c) -> c.add(credential))... .build();
- パラメーター:
credentials
- - 資格情報のコレクションを変更できるコンシューマー- 戻り値:
- このオブジェクト
assertionConsumerServiceUrlTemplate
@Deprecated public RelyingPartyRegistration.Builder assertionConsumerServiceUrlTemplate(java.lang.String assertionConsumerServiceUrlTemplate)
使用すべきではありません。代わりにassertionConsumerServiceLocation
を使用してください。- パラメーター:
assertionConsumerServiceUrlTemplate
- アサーションコンシューマーサービス URL テンプレート("{baseUrl}/login/saml2/sso/{registrationId}" など)- 戻り値:
- このオブジェクト
remoteIdpEntityId
@Deprecated public RelyingPartyRegistration.Builder remoteIdpEntityId(java.lang.String entityId)
使用すべきではありません。#assertingPartyDetails(Consumer<AssertingPartyDetails.Builder >)
を使用リモートアサーティングパーティである ID プロバイダーのentityId
を設定します。- パラメーター:
entityId
- IDP entityId- 戻り値:
- このオブジェクト
idpWebSsoUrl
@Deprecated public RelyingPartyRegistration.Builder idpWebSsoUrl(java.lang.String url)
使用すべきではありません。#assertingPartyDetails(Consumer<AssertingPartyDetails.Builder >)
を使用リモートアサーティングパーティである ID プロバイダーのSSO URL
を設定します。- パラメーター:
url
- -REDIRECT または POST バインディングを介して認証リクエストを受け入れる URL- 戻り値:
- このオブジェクト
localEntityIdTemplate
@Deprecated public RelyingPartyRegistration.Builder localEntityIdTemplate(java.lang.String template)
使用すべきではありません。代わりにentityId
を使用してくださいローカルの証明書利用者またはサービスプロバイダーのエンティティ ID テンプレートを設定します。{baseUrl}/saml2/service-provider-metadata/{registrationId}
などのbaseUrl
、registrationId
、baseScheme
、baseHost
、basePort
の可能な変数に基づいてエンティティ ID を生成できます- パラメーター:
template
- エンティティ ID- 戻り値:
- エンティティ ID またはエンティティ ID テンプレートを含む文字列
providerDetails
@Deprecated public RelyingPartyRegistration.Builder providerDetails(java.util.function.Consumer<RelyingPartyRegistration.ProviderDetails.Builder> providerDetails)
使用すべきではありません。IDP SSO エンドポイントを構成します- パラメーター:
providerDetails
- IDP SSO エンドポイントを構成するコンシューマー- 戻り値:
- このオブジェクト
build
public RelyingPartyRegistration build()
ビルダー構成に基づいて RelyingPartyRegistration オブジェクトを構築します- 戻り値:
- RelyingPartyRegistration インスタンス