AbstractSaml2AuthenticationRequest (spring-security-docs API) - Javadoc

java.lang.Object
- org.springframework.security.saml2.provider.service.authentication.AbstractSaml2AuthenticationRequest

既知の直属サブクラス
Saml2PostAuthenticationRequest, Saml2RedirectAuthenticationRequest
```
public abstract class AbstractSaml2AuthenticationRequest
extends java.lang.Object
```
Saml2MessageBinding.POST または Saml2MessageBinding.REDIRECT バインディングのいずれかを使用して送信される AuthNRequest パラメーターのデータホルダー。データはエンコードされ、場合によっては収縮されますが、トランスポートのためにエスケープされません。つまり、URL エンコードされた UriUtils.encode(String, Charset) または HTML エンコードされた HtmlUtils.htmlEscape(String) です。https://www.oasis-open.org/committees/download.php/35711/sstc-saml-core-errata-2.0-wd-06-diff.pdf (2031 行目)
導入:
5.3
関連事項:
Saml2AuthenticationRequestFactory.createPostAuthenticationRequest(Saml2AuthenticationRequestContext), Saml2AuthenticationRequestFactory.createRedirectAuthenticationRequest(Saml2AuthenticationRequestContext)

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

ネストされたクラス
修飾子と型	クラス	説明
`static class`	`AbstractSaml2AuthenticationRequest.Builder<T extends AbstractSaml2AuthenticationRequest.Builder<T>>`	`AbstractSaml2AuthenticationRequest` とそのサブクラスのビルダー。

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド
修飾子と型	メソッド	説明
`java.lang.String`	`getAuthenticationRequestUri()`	この AuthNRequest の送信先となる URI エンドポイントを返します。
`abstract Saml2MessageBinding`	`getBinding()`	この AuthNRequest が送信およびエンコードされるバインディングを返します。
`java.lang.String`	`getRelayState()`	パラメーターに存在する場合、RelayState 値を返します
`java.lang.String`	`getSamlRequest()`	送信する AuthNRequest XML 値を返します。

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

- メソッドの詳細
  - getSamlRequest
```
public java.lang.String getSamlRequest()
```
    送信する AuthNRequest XML 値を返します。この値は、トランスポート用にすでにエンコードされています。getBinding() が Saml2MessageBinding.REDIRECT の場合、値はデフレートされ、SAML エンコードされます。getBinding() が Saml2MessageBinding.POST の場合、値は SAML エンコードされます。
    戻り値:
    SAMLRequest パラメーター値
  - getRelayState
```
public java.lang.String getRelayState()
```
    パラメーターに存在する場合、RelayState 値を返します
    戻り値:
    RelayState 値、または使用できない場合は null
  - getAuthenticationRequestUri
```
public java.lang.String getAuthenticationRequestUri()
```
    この AuthNRequest の送信先となる URI エンドポイントを返します。
    戻り値:
    このメッセージの URI エンドポイント
  - getBinding
```
public abstract Saml2MessageBinding getBinding()
```
    この AuthNRequest が送信およびエンコードされるバインディングを返します。Saml2MessageBinding.REDIRECT を使用すると、DEFLATE エンコーディングが自動的に適用されます。
    戻り値:
    このメッセージが送信されるバインディング。