java.lang.Object
- org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration

public final class RelyingPartyRegistration
extends java.lang.Object

構成済みの証明書利用者（別名サービスプロバイダー）とアサーティングパーティー（別名 ID プロバイダー）のペアを表します。

各 RP/AP ペアは、任意の文字列である registrationId を使用して一意に識別されます。

完全に構成された登録は次のようになります。

        String registrationId = "simplesamlphp";

        String relyingPartyEntityId = "{baseUrl}/saml2/service-provider-metadata/{registrationId}";
        String assertionConsumerServiceLocation = "{baseUrl}/login/saml2/sso/{registrationId}";
        Saml2X509Credential relyingPartySigningCredential = ...;

        String assertingPartyEntityId = "https://simplesaml-for-spring-saml.apps.pcfone.io/saml2/idp/metadata.php";
        String singleSignOnServiceLocation = "https://simplesaml-for-spring-saml.apps.pcfone.io/saml2/idp/SSOService.php";
        Saml2X509Credential assertingPartyVerificationCredential = ...;


        RelyingPartyRegistration rp = RelyingPartyRegistration.withRegistrationId(registrationId)
                        .entityId(relyingPartyEntityId)
                        .assertionConsumerServiceLocation(assertingConsumerServiceLocation)
                        .signingX509Credentials((c) -> c.add(relyingPartySigningCredential))
                        .assertingPartyDetails((details) -> details
                                .entityId(assertingPartyEntityId));
                                .singleSignOnServiceLocation(singleSignOnServiceLocation))
                                .verifyingX509Credentials((c) -> c.add(assertingPartyVerificationCredential))
                        .build();

導入:: 5.2

ネストされたクラスのサマリー

ネストされたクラス
修飾子と型	クラス	説明
`static class`	`RelyingPartyRegistration.AssertingPartyDetails`	アサーティングパーティの構成メタデータ
`static class`	`RelyingPartyRegistration.Builder`
`static class`	`RelyingPartyRegistration.ProviderDetails`	使用すべきではありません。代わりに `RelyingPartyRegistration.AssertingPartyDetails` を使用してください

メソッドのサマリー

すべてのメソッド静的メソッドインスタンスメソッド具象メソッド非推奨のメソッド
修飾子と型	メソッド	説明
`RelyingPartyRegistration.AssertingPartyDetails`	`getAssertingPartyDetails()`	アサーティングパーティの構成の詳細を取得する
`Saml2MessageBinding`	`getAssertionConsumerServiceBinding()`	AssertionConsumerService バインディングを取得します。
`java.lang.String`	`getAssertionConsumerServiceLocation()`	AssertionConsumerService の場所を取得します。
`java.lang.String`	`getAssertionConsumerServiceUrlTemplate()`	使用すべきではありません。代わりに `getAssertionConsumerServiceLocation()` を使用してください
`java.util.List<Saml2X509Credential>`	`getCredentials()`	使用すべきではありません。すべての資格情報を取得する代わりに、適切な型を使用して正しい型を取得します
`java.util.List<Saml2X509Credential>`	`getDecryptionCredentials()`	使用すべきではありません。代わりに `getDecryptionX509Credentials()` を使用してください
`java.util.Collection<Saml2X509Credential>`	`getDecryptionX509Credentials()`	この証明書利用者に関連付けられている復号化 `Saml2X509Credential` の `Collection` を取得します
`java.util.List<Saml2X509Credential>`	`getEncryptionCredentials()`	使用すべきではありません。代わりに `RelyingPartyRegistration.AssertingPartyDetails.getEncryptionX509Credentials()` を使用してください
`java.lang.String`	`getEntityId()`	証明書利用者の EntityID を取得します。
`java.lang.String`	`getIdpWebSsoUrl()`	使用すべきではありません。 `getAssertingPartyDetails()` から `RelyingPartyRegistration.AssertingPartyDetails.getSingleSignOnServiceLocation()` を使用する
`java.lang.String`	`getLocalEntityIdTemplate()`	使用すべきではありません。代わりに `getEntityId()` を使用してください
`java.lang.String`	`getNameIdFormat()`	NameID 形式を取得します。
`RelyingPartyRegistration.ProviderDetails`	`getProviderDetails()`	使用すべきではありません。代わりに `getAssertingPartyDetails()` を使用してください
`java.lang.String`	`getRegistrationId()`	この RP/AP ペアの一意の登録 ID を取得します
`java.lang.String`	`getRemoteIdpEntityId()`	使用すべきではありません。 `getAssertingPartyDetails()` から `RelyingPartyRegistration.AssertingPartyDetails.getEntityId()` を使用する
`java.util.List<Saml2X509Credential>`	`getSigningCredentials()`	使用すべきではありません。代わりに `getSigningX509Credentials()` を使用してください
`java.util.Collection<Saml2X509Credential>`	`getSigningX509Credentials()`	この証明書利用者に関連付けられている署名 `Saml2X509Credential` の `Collection` を取得します
`Saml2MessageBinding`	`getSingleLogoutServiceBinding()`	SingleLogoutService バインディングを入手する
`java.lang.String`	`getSingleLogoutServiceLocation()`	SingleLogoutService の場所を入手する
`java.lang.String`	`getSingleLogoutServiceResponseLocation()`	SingleLogoutService レスポンス場所を入手する
`java.util.List<Saml2X509Credential>`	`getVerificationCredentials()`	使用すべきではありません。代わりに {code #getAssertingPartyDetails()。getSigningX509Credentials()} を使用してください
`static RelyingPartyRegistration.Builder`	`withAssertingPartyDetails(RelyingPartyRegistration.AssertingPartyDetails assertingPartyDetails)`
`static RelyingPartyRegistration.Builder`	`withRegistrationId(java.lang.String registrationId)`	既知の `registrationId` で `RelyingPartyRegistration` `RelyingPartyRegistration.Builder` を作成します
`static RelyingPartyRegistration.Builder`	`withRelyingPartyRegistration(RelyingPartyRegistration registration)`	既存のオブジェクトに基づいて `RelyingPartyRegistration` `RelyingPartyRegistration.Builder` を作成します

クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- メソッドの詳細
  - getRegistrationId
```
public java.lang.String getRegistrationId()
```
    この RP/AP ペアの一意の登録 ID を取得します
    戻り値:
    この RP/AP ペアの一意の登録 ID
  - getEntityId
```
public java.lang.String getEntityId()
```
    証明書利用者の EntityID を取得します。
    証明書利用者の <EntityDescriptor EntityID="..." /> にある値に相当します
    この値には、使用する前に解決する必要のあるいくつかのプレースホルダーが含まれている場合があります。それらは baseUrl、registrationId、baseScheme、baseHost、basePort です。
    戻り値:
    依存パーティの EntityID
    導入:
    5.4
  - getAssertionConsumerServiceLocation
```
public java.lang.String getAssertionConsumerServiceLocation()
```
    AssertionConsumerService の場所を取得します。証明書利用者の <SPSSODescriptor> の <AssertionConsumerService Location="..." /> にある値に相当します。この値には、使用する前に解決する必要のあるいくつかのプレースホルダーが含まれている場合があります。それらは baseUrl、registrationId、baseScheme、baseHost、basePort です。
    戻り値:
    AssertionConsumerService ロケーション
    導入:
    5.4
  - getAssertionConsumerServiceBinding
```
public Saml2MessageBinding getAssertionConsumerServiceBinding()
```
    AssertionConsumerService バインディングを取得します。証明書利用者の <SPSSODescriptor> の <AssertionConsumerService Binding="..." /> にある値に相当します。
    戻り値:
    AssertionConsumerService バインディング
    導入:
    5.4
  - getSingleLogoutServiceBinding
```
public Saml2MessageBinding getSingleLogoutServiceBinding()
```
    SingleLogoutService バインディングを入手する
    証明書利用者の <SPSSODescriptor> の <SingleLogoutService Binding="..." /> にある値に相当します。
    戻り値:
    SingleLogoutService バインディング
    導入:
    5.6
  - getSingleLogoutServiceLocation
```
public java.lang.String getSingleLogoutServiceLocation()
```
    SingleLogoutService の場所を入手する
    証明書利用者の <SPSSODescriptor> の <SingleLogoutService Location="..." /> にある値に相当します。
    戻り値:
    SingleLogoutService ロケーション
    導入:
    5.6
  - getSingleLogoutServiceResponseLocation
```
public java.lang.String getSingleLogoutServiceResponseLocation()
```
    SingleLogoutService レスポンス場所を入手する
    証明書利用者の <SPSSODescriptor> の <SingleLogoutService ResponseLocation="..." /> にある値に相当します。
    戻り値:
    SingleLogoutService レスポンス位置
    導入:
    5.6
  - getNameIdFormat
```
public java.lang.String getNameIdFormat()
```
    NameID 形式を取得します。
    戻り値:
    NameID 形式
    導入:
    5.7
  - getDecryptionX509Credentials
```
public java.util.Collection<Saml2X509Credential> getDecryptionX509Credentials()
```
    この証明書利用者に関連付けられている復号化 Saml2X509Credential の Collection を取得します
    戻り値:
    この依存パーティに関連付けられている復号化 Saml2X509Credential の Collection
    導入:
    5.4
  - getSigningX509Credentials
```
public java.util.Collection<Saml2X509Credential> getSigningX509Credentials()
```
    この証明書利用者に関連付けられている署名 Saml2X509Credential の Collection を取得します
    戻り値:
    この依存パーティに関連付けられている署名 Saml2X509Credential の Collection
    導入:
    5.4
  - getAssertingPartyDetails
```
public RelyingPartyRegistration.AssertingPartyDetails getAssertingPartyDetails()
```
    アサーティングパーティの構成の詳細を取得する
    戻り値:
    RelyingPartyRegistration.AssertingPartyDetails
    導入:
    5.4
  - getRemoteIdpEntityId
```
@Deprecated
public java.lang.String getRemoteIdpEntityId()
```
    使用すべきではありません。
    getAssertingPartyDetails() から RelyingPartyRegistration.AssertingPartyDetails.getEntityId() を使用する
    アサーティングパーティである IDP のエンティティ ID を返します。
    戻り値:
    アサーティングパーティのエンティティ ID
  - getAssertionConsumerServiceUrlTemplate
```
@Deprecated
public java.lang.String getAssertionConsumerServiceUrlTemplate()
```
    使用すべきではありません。
    代わりに getAssertionConsumerServiceLocation() を使用してください
    ACSURL 認証リクエストに含める必要のある URL テンプレートを返します。可能な変数は baseUrl、registrationId、baseScheme、baseHost、basePort です。
    戻り値:
    変数の有無にかかわらず、ACS URL テンプレートを含む文字列
  - getIdpWebSsoUrl
```
@Deprecated
public java.lang.String getIdpWebSsoUrl()
```
    使用すべきではありません。
    getAssertingPartyDetails() から RelyingPartyRegistration.AssertingPartyDetails.getSingleSignOnServiceLocation() を使用する
    シングルサインオンフローを開始するために SAML 2 認証リクエストを送信するための URL が含まれています。
    戻り値:
    認証リクエストの REDIRECT または POST バインディングを受け入れる IDP URL
  - getProviderDetails
```
@Deprecated
public RelyingPartyRegistration.ProviderDetails getProviderDetails()
```
    使用すべきではありません。
    代わりに getAssertingPartyDetails() を使用してください
    ID プロバイダー SSO エンドポイント周辺の特定の構成を返します
    戻り値:
    IDP SSO エンドポイント構成
    導入:
    5.3
  - getLocalEntityIdTemplate
```
@Deprecated
public java.lang.String getLocalEntityIdTemplate()
```
    使用すべきではありません。
    代わりに getEntityId() を使用してください
    ローカルの証明書利用者またはサービスプロバイダーは、baseUrl、registrationId、baseScheme、baseHost、basePort の可能な変数（{baseUrl}/saml2/service-provider-metadata/{registrationId} など）に基づいてエンティティ ID を生成できます。
    戻り値:
    エンティティ ID またはエンティティ ID テンプレートを含む文字列
  - getCredentials
```
@Deprecated
public java.util.List<Saml2X509Credential> getCredentials()
```
    使用すべきではありません。
    すべての資格情報を取得する代わりに、適切な型を使用して正しい型を取得します
    証明書利用者 SP とアサーティングパーティ IDP との間のメッセージ交換で使用される構成済み資格情報のリストを返します。
    戻り値:
    資格情報のリスト
  - getVerificationCredentials
```
@Deprecated
public java.util.List<Saml2X509Credential> getVerificationCredentials()
```
    使用すべきではありません。
    代わりに {code #getAssertingPartyDetails()。getSigningX509Credentials()} を使用してください
    戻り値:
    型 Saml2X509Credential.Saml2X509CredentialType.VERIFICATION の資格情報のみを含むフィルターされたリスト。資格情報が見つからない空のリストを返します
  - getSigningCredentials
```
@Deprecated
public java.util.List<Saml2X509Credential> getSigningCredentials()
```
    使用すべきではありません。
    代わりに getSigningX509Credentials() を使用してください
    戻り値:
    型 Saml2X509Credential.Saml2X509CredentialType.SIGNING の資格情報のみを含むフィルターされたリスト。資格情報が見つからない空のリストを返します
  - getEncryptionCredentials
```
@Deprecated
public java.util.List<Saml2X509Credential> getEncryptionCredentials()
```
    使用すべきではありません。
    代わりに RelyingPartyRegistration.AssertingPartyDetails.getEncryptionX509Credentials() を使用してください
    戻り値:
    型 Saml2X509Credential.Saml2X509CredentialType.ENCRYPTION の資格情報のみを含むフィルターされたリスト。資格情報が見つからない空のリストを返します
  - getDecryptionCredentials
```
@Deprecated
public java.util.List<Saml2X509Credential> getDecryptionCredentials()
```
    使用すべきではありません。
    代わりに getDecryptionX509Credentials() を使用してください
    戻り値:
    型 Saml2X509Credential.Saml2X509CredentialType.DECRYPTION の資格情報のみを含むフィルターされたリスト。資格情報が見つからない空のリストを返します
  - withRegistrationId
```
public static RelyingPartyRegistration.Builder withRegistrationId(java.lang.String registrationId)
```
    既知の registrationId で RelyingPartyRegistration RelyingPartyRegistration.Builder を作成します
    パラメーター:
    registrationId - RelyingPartyRegistration の文字列識別子
    戻り値:
    RelyingPartyRegistration オブジェクトを作成する Builder
  - withAssertingPartyDetails
```
public static RelyingPartyRegistration.Builder withAssertingPartyDetails(RelyingPartyRegistration.AssertingPartyDetails assertingPartyDetails)
```
  - withRelyingPartyRegistration
```
public static RelyingPartyRegistration.Builder withRelyingPartyRegistration(RelyingPartyRegistration registration)
```
    既存のオブジェクトに基づいて RelyingPartyRegistration RelyingPartyRegistration.Builder を作成します
    パラメーター:
    registration - RelyingPartyRegistration
    戻り値:
    RelyingPartyRegistration オブジェクトを作成する Builder

クラス RelyingPartyRegistration

ネストされたクラスのサマリー

メソッドのサマリー

クラス java.lang.Object から継承されたメソッド

メソッドの詳細

getRegistrationId

getEntityId

getAssertionConsumerServiceLocation

getAssertionConsumerServiceBinding

getSingleLogoutServiceBinding

getSingleLogoutServiceLocation

getSingleLogoutServiceResponseLocation

getNameIdFormat

getDecryptionX509Credentials

getSigningX509Credentials

getAssertingPartyDetails

getRemoteIdpEntityId

getAssertionConsumerServiceUrlTemplate

getIdpWebSsoUrl

getProviderDetails

getLocalEntityIdTemplate

getCredentials

getVerificationCredentials

getSigningCredentials

getEncryptionCredentials

getDecryptionCredentials

withRegistrationId

withAssertingPartyDetails

withRelyingPartyRegistration