クラス SecurityMockMvcRequestPostProcessors
- java.lang.Object
-
- org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors
public final class SecurityMockMvcRequestPostProcessors extends java.lang.Object
MockMvc
が含まれています。Spring Security のRequestPostProcessor
実装。- 導入:
- 4.0
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 クラス 説明 static class
SecurityMockMvcRequestPostProcessors.CsrfRequestPostProcessor
有効なCsrfToken
をリクエストに入力します。static class
SecurityMockMvcRequestPostProcessors.DigestRequestPostProcessor
static class
SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor
static class
SecurityMockMvcRequestPostProcessors.OAuth2ClientRequestPostProcessor
static class
SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor
static class
SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor
static class
SecurityMockMvcRequestPostProcessors.OpaqueTokenRequestPostProcessor
static class
SecurityMockMvcRequestPostProcessors.UserRequestPostProcessor
メソッドのサマリー
すべてのメソッド 静的メソッド 具象メソッド 修飾子と型 メソッド 説明 static org.springframework.test.web.servlet.request.RequestPostProcessor
anonymous()
AnonymousAuthenticationToken
を使用するSecurityContext
を確立します。static org.springframework.test.web.servlet.request.RequestPostProcessor
authentication(Authentication authentication)
static SecurityMockMvcRequestPostProcessors.CsrfRequestPostProcessor
csrf()
リクエストに有効なCsrfToken
を自動的に入力するRequestPostProcessor
を作成します。static SecurityMockMvcRequestPostProcessors.DigestRequestPostProcessor
digest()
リクエストにダイジェストベースの認証を簡単に追加できる DigestRequestPostProcessor を作成します。static SecurityMockMvcRequestPostProcessors.DigestRequestPostProcessor
digest(java.lang.String username)
リクエストにダイジェストベースの認証を簡単に追加できる DigestRequestPostProcessor を作成します。static org.springframework.test.web.servlet.request.RequestPostProcessor
httpBasic(java.lang.String username, java.lang.String password)
指定されたユーザー名とパスワードで HTTP Basic を使用するように Authorization ヘッダーを設定するための便利なメカニズム。static SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor
jwt()
Authentication
用のJwtAuthenticationToken
とAuthentication.getPrincipal()
用のJwt
を持つSecurityContext
を確立します。static SecurityMockMvcRequestPostProcessors.OAuth2ClientRequestPostProcessor
oauth2Client()
セッションでOAuth2AuthorizedClient
を確立します。static SecurityMockMvcRequestPostProcessors.OAuth2ClientRequestPostProcessor
oauth2Client(java.lang.String registrationId)
セッションでOAuth2AuthorizedClient
を確立します。static SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor
oauth2Login()
Authentication
のOAuth2AuthenticationToken
、プリンシパルとしてのOAuth2User
、セッション内のOAuth2AuthorizedClient
を持つSecurityContext
を確立します。static SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor
oidcLogin()
Authentication
のOAuth2AuthenticationToken
、プリンシパルとしてのOidcUser
、セッション内のOAuth2AuthorizedClient
を持つSecurityContext
を確立します。static SecurityMockMvcRequestPostProcessors.OpaqueTokenRequestPostProcessor
opaqueToken()
static org.springframework.test.web.servlet.request.RequestPostProcessor
securityContext(SecurityContext securityContext)
使用する指定のSecurityContext
を確立します。static org.springframework.test.web.servlet.request.RequestPostProcessor
testSecurityContext()
結果のリクエストがTestSecurityContextHolder
のユーザーと共に実行されることを保証するために使用できるRequestPostProcessor
を作成します。static SecurityMockMvcRequestPostProcessors.UserRequestPostProcessor
user(java.lang.String username)
static org.springframework.test.web.servlet.request.RequestPostProcessor
user(UserDetails user)
static org.springframework.test.web.servlet.request.RequestPostProcessor
x509(java.lang.String resourceName)
resoureName を使用して X509Cetificate を検索し、リクエストに入力します。static org.springframework.test.web.servlet.request.RequestPostProcessor
x509(java.security.cert.X509Certificate... certificates)
提供された X509Certificate インスタンスをリクエストに追加します。
メソッドの詳細
digest
public static SecurityMockMvcRequestPostProcessors.DigestRequestPostProcessor digest()
リクエストにダイジェストベースの認証を簡単に追加できる DigestRequestPostProcessor を作成します。- 戻り値:
- 使用する DigestRequestPostProcessor
digest
public static SecurityMockMvcRequestPostProcessors.DigestRequestPostProcessor digest(java.lang.String username)
リクエストにダイジェストベースの認証を簡単に追加できる DigestRequestPostProcessor を作成します。- パラメーター:
username
- 使用するユーザー名- 戻り値:
- 使用する DigestRequestPostProcessor
x509
public static org.springframework.test.web.servlet.request.RequestPostProcessor x509(java.security.cert.X509Certificate... certificates)
提供された X509Certificate インスタンスをリクエストに追加します。- パラメーター:
certificates
- 蓄積する X509Certificate インスタンス- 戻り値:
- 使用する
RequestPostProcessor
x509
public static org.springframework.test.web.servlet.request.RequestPostProcessor x509(java.lang.String resourceName) throws java.io.IOException, java.security.cert.CertificateException
resoureName を使用して X509Cetificate を検索し、リクエストに入力します。- パラメーター:
resourceName
- X509Certificate リソースの名前- 戻り値:
- 使用する
RequestPostProcessor
- 例外:
java.io.IOException
java.security.cert.CertificateException
csrf
public static SecurityMockMvcRequestPostProcessors.CsrfRequestPostProcessor csrf()
リクエストに有効なCsrfToken
を自動的に入力するRequestPostProcessor
を作成します。- 戻り値:
SecurityMockMvcRequestPostProcessors.CsrfRequestPostProcessor
をさらにカスタマイズします。
testSecurityContext
public static org.springframework.test.web.servlet.request.RequestPostProcessor testSecurityContext()
結果のリクエストがTestSecurityContextHolder
のユーザーと共に実行されることを保証するために使用できるRequestPostProcessor
を作成します。- 戻り値:
- 訴える
RequestPostProcessor
user
public static SecurityMockMvcRequestPostProcessors.UserRequestPostProcessor user(java.lang.String username)
Authentication.getPrincipal()
用のUsernamePasswordAuthenticationToken
とUsernamePasswordAuthenticationToken.getPrincipal()
用のUser
を持つSecurityContext
を確立します。詳細はすべて宣言的であり、ユーザーが実際に存在する必要はありません。サポートは、ユーザーを HttpServletRequest に関連付けることで機能します。リクエストを SecurityContextHolder に関連付けるには、SecurityContextPersistenceFilter が MockMvc インスタンスに関連付けられていることを確認する必要があります。これを行ういくつかの方法は次のとおりです。
- 適用
SecurityMockMvcConfigurers.springSecurity()
の呼び出し - Spring Security の FilterChainProxy を MockMvc に追加する
- MockMvcBuilders standaloneSetup を使用する場合は、MockMvc インスタンスに
SecurityContextPersistenceFilter
を手動で追加すると意味があるかもしれません。
- パラメーター:
username
- 入力するユーザー名- 戻り値:
- 追加のカスタマイズのための
SecurityMockMvcRequestPostProcessors.UserRequestPostProcessor
- 適用
user
public static org.springframework.test.web.servlet.request.RequestPostProcessor user(UserDetails user)
Authentication.getPrincipal()
用のUsernamePasswordAuthenticationToken
とUsernamePasswordAuthenticationToken.getPrincipal()
用のカスタムUserDetails
を持つSecurityContext
を確立します。詳細はすべて宣言的であり、ユーザーが実際に存在する必要はありません。サポートは、ユーザーを HttpServletRequest に関連付けることで機能します。リクエストを SecurityContextHolder に関連付けるには、SecurityContextPersistenceFilter が MockMvc インスタンスに関連付けられていることを確認する必要があります。これを行ういくつかの方法は次のとおりです。
- 適用
SecurityMockMvcConfigurers.springSecurity()
の呼び出し - Spring Security の FilterChainProxy を MockMvc に追加する
- MockMvcBuilders standaloneSetup を使用する場合は、MockMvc インスタンスに
SecurityContextPersistenceFilter
を手動で追加すると意味があるかもしれません。
- パラメーター:
user
- 投入する UserDetails- 戻り値:
- 使用する
RequestPostProcessor
- 適用
jwt
public static SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor jwt()
Authentication
用のJwtAuthenticationToken
とAuthentication.getPrincipal()
用のJwt
を持つSecurityContext
を確立します。詳細はすべて宣言型であり、JWT が有効である必要はありません。サポートは、認証を HttpServletRequest に関連付けることによって機能します。リクエストを SecurityContextHolder に関連付けるには、SecurityContextPersistenceFilter が MockMvc インスタンスに関連付けられていることを確認する必要があります。これを行ういくつかの方法は次のとおりです。
- 適用
SecurityMockMvcConfigurers.springSecurity()
の呼び出し - Spring Security の FilterChainProxy を MockMvc に追加する
- MockMvcBuilders standaloneSetup を使用する場合は、MockMvc インスタンスに
SecurityContextPersistenceFilter
を手動で追加すると意味があるかもしれません。
- 戻り値:
- 追加のカスタマイズのための
SecurityMockMvcRequestPostProcessors.JwtRequestPostProcessor
- 適用
opaqueToken
public static SecurityMockMvcRequestPostProcessors.OpaqueTokenRequestPostProcessor opaqueToken()
Authentication
用のBearerTokenAuthentication
とAuthentication.getPrincipal()
用のOAuth2AuthenticatedPrincipal
を持つSecurityContext
を確立します。すべての詳細は宣言的であり、トークンが有効である必要はありませんサポートは、認証を HttpServletRequest に関連付けることによって機能します。リクエストを SecurityContextHolder に関連付けるには、SecurityContextPersistenceFilter が MockMvc インスタンスに関連付けられていることを確認する必要があります。これを行ういくつかの方法は次のとおりです。
- 適用
SecurityMockMvcConfigurers.springSecurity()
の呼び出し - Spring Security の FilterChainProxy を MockMvc に追加する
- MockMvcBuilders standaloneSetup を使用する場合は、MockMvc インスタンスに
SecurityContextPersistenceFilter
を手動で追加すると意味があるかもしれません。
- 戻り値:
- 追加のカスタマイズのための
SecurityMockMvcRequestPostProcessors.OpaqueTokenRequestPostProcessor
- 導入:
- 5.3
- 適用
authentication
public static org.springframework.test.web.servlet.request.RequestPostProcessor authentication(Authentication authentication)
Authentication.getPrincipal()
の指定されたAuthentication
とカスタムUserDetails
を使用するSecurityContext
を確立します。詳細はすべて宣言的であり、ユーザーが実際に存在する必要はありません。サポートは、ユーザーを HttpServletRequest に関連付けることで機能します。リクエストを SecurityContextHolder に関連付けるには、SecurityContextPersistenceFilter が MockMvc インスタンスに関連付けられていることを確認する必要があります。これを行ういくつかの方法は次のとおりです。
- 適用
SecurityMockMvcConfigurers.springSecurity()
の呼び出し - Spring Security の FilterChainProxy を MockMvc に追加する
- MockMvcBuilders standaloneSetup を使用する場合は、MockMvc インスタンスに
SecurityContextPersistenceFilter
を手動で追加すると意味があるかもしれません。
- パラメーター:
authentication
- 入力する認証- 戻り値:
- 使用する
RequestPostProcessor
- 適用
anonymous
public static org.springframework.test.web.servlet.request.RequestPostProcessor anonymous()
AnonymousAuthenticationToken
を使用するSecurityContext
を確立します。これは、ユーザーが特定のユーザーとして大多数のテストを実行したい場合や、いくつかのメソッドを匿名にオーバーライドしたい場合に役立ちます。例:public class SecurityTests { @Before public void setup() { mockMvc = MockMvcBuilders .webAppContextSetup(context) .defaultRequest(get("/").with(user("user"))) .build(); } @Test public void anonymous() { mockMvc.perform(get("anonymous").with(anonymous())); } // ... lots of tests ran with a default user ... }
- 戻り値:
- 使用する
RequestPostProcessor
securityContext
public static org.springframework.test.web.servlet.request.RequestPostProcessor securityContext(SecurityContext securityContext)
使用する指定のSecurityContext
を確立します。これは、ユーザーを
HttpServletRequest
に関連付けることによって機能します。リクエストをSecurityContextHolder
に関連付けるには、SecurityContextPersistenceFilter
(つまり、Spring Security の FilterChainProxy が通常これを行う)がMockMvc
インスタンスに関連付けられていることを確認する必要があります。
httpBasic
public static org.springframework.test.web.servlet.request.RequestPostProcessor httpBasic(java.lang.String username, java.lang.String password)
指定されたユーザー名とパスワードで HTTP Basic を使用するように Authorization ヘッダーを設定するための便利なメカニズム。このメソッドは、必要な Base64 エンコーディングを自動的に実行します。- パラメーター:
username
- Authorization ヘッダーに含めるユーザー名password
- Authorization ヘッダーに含めるパスワード- 戻り値:
- 使用する
RequestPostProcessor
oauth2Login
public static SecurityMockMvcRequestPostProcessors.OAuth2LoginRequestPostProcessor oauth2Login()
Authentication
のOAuth2AuthenticationToken
、プリンシパルとしてのOAuth2User
、セッション内のOAuth2AuthorizedClient
を持つSecurityContext
を確立します。すべての詳細は宣言的であり、関連付けられたトークンが有効である必要はありません。サポートは、認証を HttpServletRequest に関連付けることによって機能します。リクエストを SecurityContextHolder に関連付けるには、SecurityContextPersistenceFilter が MockMvc インスタンスに関連付けられていることを確認する必要があります。これを行ういくつかの方法は次のとおりです。
- 適用
SecurityMockMvcConfigurers.springSecurity()
の呼び出し - Spring Security の FilterChainProxy を MockMvc に追加する
- MockMvcBuilders standaloneSetup を使用する場合は、MockMvc インスタンスに
SecurityContextPersistenceFilter
を手動で追加すると意味があるかもしれません。
- 戻り値:
- 追加のカスタマイズのための
SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor
- 導入:
- 5.3
- 適用
oidcLogin
public static SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor oidcLogin()
Authentication
のOAuth2AuthenticationToken
、プリンシパルとしてのOidcUser
、セッション内のOAuth2AuthorizedClient
を持つSecurityContext
を確立します。すべての詳細は宣言的であり、関連付けられたトークンが有効である必要はありません。サポートは、認証を HttpServletRequest に関連付けることによって機能します。リクエストを SecurityContextHolder に関連付けるには、SecurityContextPersistenceFilter が MockMvc インスタンスに関連付けられていることを確認する必要があります。これを行ういくつかの方法は次のとおりです。
- 適用
SecurityMockMvcConfigurers.springSecurity()
の呼び出し - Spring Security の FilterChainProxy を MockMvc に追加する
- MockMvcBuilders standaloneSetup を使用する場合は、MockMvc インスタンスに
SecurityContextPersistenceFilter
を手動で追加すると意味があるかもしれません。
- 戻り値:
- 追加のカスタマイズのための
SecurityMockMvcRequestPostProcessors.OidcLoginRequestPostProcessor
- 導入:
- 5.3
- 適用
oauth2Client
public static SecurityMockMvcRequestPostProcessors.OAuth2ClientRequestPostProcessor oauth2Client()
セッションでOAuth2AuthorizedClient
を確立します。すべての詳細は宣言型であり、関連するトークンが有効である必要はありません。サポートは、認可されたクライアントを
HttpSessionOAuth2AuthorizedClientRepository
を介して HttpServletRequest に関連付けることによって機能します。- 戻り値:
- 追加のカスタマイズのための
SecurityMockMvcRequestPostProcessors.OAuth2ClientRequestPostProcessor
- 導入:
- 5.3
oauth2Client
public static SecurityMockMvcRequestPostProcessors.OAuth2ClientRequestPostProcessor oauth2Client(java.lang.String registrationId)
セッションでOAuth2AuthorizedClient
を確立します。すべての詳細は宣言型であり、関連するトークンが有効である必要はありません。サポートは、認可されたクライアントを
HttpSessionOAuth2AuthorizedClientRepository
を介して HttpServletRequest に関連付けることによって機能します。- パラメーター:
registrationId
-OAuth2AuthorizedClient
の登録 ID- 戻り値:
- 追加のカスタマイズのための
SecurityMockMvcRequestPostProcessors.OAuth2ClientRequestPostProcessor
- 導入:
- 5.3