クラス RelyingPartyRegistrations
- java.lang.Object
-
- org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistrations
public final class RelyingPartyRegistrations extends java.lang.Object
RelyingPartyRegistration
のインスタンスを作成するためのユーティリティクラス- 導入:
- 5.4
メソッドのサマリー
すべてのメソッド 静的メソッド 具象メソッド 修飾子と型 メソッド 説明 static java.util.Collection<RelyingPartyRegistration.Builder>
collectionFromMetadata(java.io.InputStream source)
指定された SAML 2.0 Asserting Party(IDP)メタデータに基づいてRelyingPartyRegistration.Builder
のCollection
を返します。static java.util.Collection<RelyingPartyRegistration.Builder>
collectionFromMetadataLocation(java.lang.String location)
指定された SAML 2.0 Asserting Party(IDP)メタデータの場所に基づいてRelyingPartyRegistration.Builder
のCollection
を返します。static RelyingPartyRegistration.Builder
fromMetadata(java.io.InputStream source)
指定された SAML 2.0 アサーティングパーティ(IDP)メタデータに基づいてRelyingPartyRegistration.Builder
を返します。static RelyingPartyRegistration.Builder
fromMetadataLocation(java.lang.String metadataLocation)
指定された SAML 2.0 Asserting Party(IDP)メタデータの場所に基づいてRelyingPartyRegistration.Builder
を返します。
メソッドの詳細
fromMetadataLocation
public static RelyingPartyRegistration.Builder fromMetadataLocation(java.lang.String metadataLocation)
指定された 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
public static RelyingPartyRegistration.Builder fromMetadata(java.io.InputStream source)
指定された 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
ソース- 戻り値:
- さらなる構成のための
RelyingPartyRegistration.Builder
- 導入:
- 5.6
collectionFromMetadataLocation
public static java.util.Collection<RelyingPartyRegistration.Builder> collectionFromMetadataLocation(java.lang.String location)
指定された SAML 2.0 Asserting Party(IDP)メタデータの場所に基づいてRelyingPartyRegistration.Builder
のCollection
を返します。有効な場所は、クラスパスベースまたはファイルベースにすることも、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
- 導入:
- 5.7
collectionFromMetadata
public static java.util.Collection<RelyingPartyRegistration.Builder> collectionFromMetadata(java.io.InputStream source)
指定された SAML 2.0 Asserting Party(IDP)メタデータに基づいてRelyingPartyRegistration.Builder
のCollection
を返します。このメソッドは、メタデータが別のメカニズムで検索されるシナリオを対象としています。そのような例の 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
ソース- 戻り値:
- さらなる構成のための
RelyingPartyRegistration.Builder
のCollection
- 導入:
- 5.7