クラス RelyingPartyRegistrations
java.lang.ObjectSE
org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistrations
RelyingPartyRegistration
のインスタンスを作成するためのユーティリティクラス - 導入:
- 5.4
メソッドのサマリー
修飾子と型メソッド説明collectionFromMetadata
(InputStreamSE source) 指定された SAML 2.0 Asserting Party (IDP) メタデータに基づいて、RelyingPartyRegistration.Builder
のCollection
SE を返します。collectionFromMetadataLocation
(StringSE location) 指定された SAML 2.0 Asserting Party (IDP) メタデータの場所に基づいて、RelyingPartyRegistration.Builder
のCollection
SE を返します。fromMetadata
(InputStreamSE source) 指定された SAML 2.0 アサーティングパーティ(IDP)メタデータに基づいてRelyingPartyRegistration.Builder
を返します。fromMetadataLocation
(StringSE metadataLocation) 指定された SAML 2.0 Asserting Party(IDP)メタデータの場所に基づいてRelyingPartyRegistration.Builder
を返します。
メソッドの詳細
fromMetadataLocation
指定された SAML 2.0 Asserting Party(IDP)メタデータの場所に基づいてRelyingPartyRegistration.Builder
を返します。有効な場所は、クラスパスベースまたはファイルベースにすることも、HTTP エンドポイントにすることもできます。有効なエンドポイントには次のものがあります。metadataLocation = "classpath:asserting-party-metadata.xml"; metadataLocation = "file:asserting-party-metadata.xml"; metadataLocation = "https://ap.example.org/metadata";
デフォルトでは、registrationId は指定されたメタデータの場所に設定されますが、ほとんどの場合これでは不十分です。構成を完了するには、ほとんどのアプリケーションで次のように registrationId も提供する必要があります。RelyingPartyRegistration registration = RelyingPartyRegistrations .fromMetadataLocation(metadataLocation) .registrationId("registration-id") .build();
また、IDPSSODescriptor
には通常、アサーティングパーティに関する情報しか含まれていないことにも注意してください。依拠当事者が AuthnRequests の署名に使用する秘密鍵など、依拠当事者については何でも入力することを忘れないでください。- パラメーター:
metadataLocation
- アサート側メタデータファイルのクラスパスベースまたはファイルベースの場所または HTTP エンドポイント- 戻り値:
- さらなる構成のための
RelyingPartyRegistration.Builder
fromMetadata
指定された SAML 2.0 アサーティングパーティ(IDP)メタデータに基づいてRelyingPartyRegistration.Builder
を返します。このメソッドは、メタデータが別のメカニズムで検索されるシナリオを対象としています。そのような例の 1 つは、メタデータがデータベースに保存されている場合です。
このメソッドの呼び出し元は、
デフォルトでは、registrationId は指定されたメタデータの場所に設定されますが、ほとんどの場合これでは不十分です。構成を完了するには、ほとんどのアプリケーションで次のように registrationId も提供する必要があります。InputStream
ソースを閉じる責任があります。String xml = fromDatabase(); try (InputStream source = new ByteArrayInputStream(xml.getBytes())) { RelyingPartyRegistration registration = RelyingPartyRegistrations .fromMetadata(source) .registrationId("registration-id") .build(); }
また、IDPSSODescriptor
には通常、アサーティングパーティに関する情報しか含まれていないことにも注意してください。依拠当事者が AuthnRequests の署名に使用する秘密鍵など、依拠当事者については何でも入力することを忘れないでください。- パラメーター:
source
- アサーティングパーティのメタデータを含むInputStream
SE ソース- 戻り値:
- さらなる構成のための
RelyingPartyRegistration.Builder
- 導入:
- 5.6
collectionFromMetadataLocation
public static CollectionSE<RelyingPartyRegistration.Builder> collectionFromMetadataLocation(StringSE location) 指定された SAML 2.0 Asserting Party (IDP) メタデータの場所に基づいて、RelyingPartyRegistration.Builder
のCollection
SE を返します。有効な場所は、クラスパスベースまたはファイルベースにするか、HTTP エンドポイントにすることができます。有効なエンドポイントには次のものがあります。metadataLocation = "classpath:asserting-party-metadata.xml"; metadataLocation = "file:asserting-party-metadata.xml"; metadataLocation = "https://ap.example.org/metadata";
デフォルトでは、registrationId は指定されたメタデータの場所に設定されますが、ほとんどの場合これでは不十分です。構成を完了するには、ほとんどのアプリケーションで次のように registrationId も提供する必要があります。Iterable<RelyingPartyRegistration> registrations = RelyingPartyRegistrations .collectionFromMetadataLocation(location).iterator(); RelyingPartyRegistration one = registrations.next().registrationId("one").build(); RelyingPartyRegistration two = registrations.next().registrationId("two").build(); return new InMemoryRelyingPartyRegistrationRepository(one, two);
また、IDPSSODescriptor
には通常、アサーティングパーティに関する情報しか含まれていないことにも注意してください。依拠当事者が AuthnRequests の署名に使用する秘密鍵など、依拠当事者については何でも入力することを忘れないでください。- パラメーター:
location
- アサート側メタデータファイルのクラスパスベースまたはファイルベースの場所または HTTP エンドポイント- 戻り値:
- さらに構成するための
RelyingPartyRegistration.Builder
のCollection
SE - 導入:
- 5.7
collectionFromMetadata
public static CollectionSE<RelyingPartyRegistration.Builder> collectionFromMetadata(InputStreamSE source) 指定された SAML 2.0 Asserting Party (IDP) メタデータに基づいて、RelyingPartyRegistration.Builder
のCollection
SE を返します。このメソッドは、メタデータが別のメカニズムで検索されるシナリオを対象としています。そのような例の 1 つは、メタデータがデータベースに保存されている場合です。
このメソッドの呼び出し元は、
デフォルトでは、registrationId は指定されたメタデータの場所に設定されますが、ほとんどの場合これでは不十分です。構成を完了するには、ほとんどのアプリケーションで次のように registrationId も提供する必要があります。InputStream
ソースを閉じる責任があります。String xml = fromDatabase(); try (InputStream source = new ByteArrayInputStream(xml.getBytes())) { Iterator<RelyingPartyRegistration> registrations = RelyingPartyRegistrations .collectionFromMetadata(source).iterator(); RelyingPartyRegistration one = registrations.next().registrationId("one").build(); RelyingPartyRegistration two = registrations.next().registrationId("two").build(); return new InMemoryRelyingPartyRegistrationRepository(one, two); }
また、IDPSSODescriptor
には通常、アサーティングパーティに関する情報しか含まれていないことにも注意してください。依拠当事者が AuthnRequests の署名に使用する秘密鍵など、依拠当事者については何でも入力することを忘れないでください。- パラメーター:
source
- アサーティングパーティのメタデータを含むInputStream
SE ソース- 戻り値:
- さらに構成するための
RelyingPartyRegistration.Builder
のCollection
SE - 導入:
- 5.7