クラス User.UserBuilder
- java.lang.Object
-
- org.springframework.security.core.userdetails.User.UserBuilder
- 含まれているクラス:
- User
public static final class User.UserBuilder extends java.lang.Object
追加するユーザーをビルドします。少なくとも、ユーザー名、パスワード、権限を提供する必要があります。残りの属性には妥当なデフォルトがあります。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 修飾子と型 メソッド 説明 User.UserBuilder
accountExpired(boolean accountExpired)
アカウントが期限切れかどうかを定義します。User.UserBuilder
accountLocked(boolean accountLocked)
アカウントがロックされているかどうかを定義します。User.UserBuilder
authorities(java.lang.String... authorities)
権限に居住します。User.UserBuilder
authorities(java.util.Collection<? extends GrantedAuthority> authorities)
権限に居住します。User.UserBuilder
authorities(GrantedAuthority... authorities)
権限に居住します。UserDetails
build()
User.UserBuilder
credentialsExpired(boolean credentialsExpired)
資格情報が期限切れかどうかを定義します。User.UserBuilder
disabled(boolean disabled)
アカウントが無効かどうかを定義します。User.UserBuilder
password(java.lang.String password)
パスワードを入力します。User.UserBuilder
passwordEncoder(java.util.function.Function<java.lang.String,java.lang.String> encoder)
現在のパスワード(null でない場合)およびpassword(String)
に提供される将来のパスワードをエンコードします。User.UserBuilder
roles(java.lang.String... roles)
ロールを移植します。User.UserBuilder
username(java.lang.String username)
ユーザー名を入力します。
メソッドの詳細
username
public User.UserBuilder username(java.lang.String username)
ユーザー名を入力します。この属性は必須です。- パラメーター:
username
- ユーザー名。null にはできません。- 戻り値:
- メソッド連鎖のための
User.UserBuilder
(つまり、このユーザーの追加属性を設定します)
password
public User.UserBuilder password(java.lang.String password)
パスワードを入力します。この属性は必須です。- パラメーター:
password
- パスワード。null にはできません。- 戻り値:
- メソッド連鎖のための
User.UserBuilder
(つまり、このユーザーの追加属性を設定します)
passwordEncoder
public User.UserBuilder passwordEncoder(java.util.function.Function<java.lang.String,java.lang.String> encoder)
現在のパスワード(null でない場合)およびpassword(String)
に提供される将来のパスワードをエンコードします。- パラメーター:
encoder
- 使用するエンコーダー- 戻り値:
- メソッド連鎖のための
User.UserBuilder
(つまり、このユーザーの追加属性を設定します)
roles
public User.UserBuilder roles(java.lang.String... roles)
ロールを移植します。このメソッドはauthorities(String...)
を呼び出すためのショートカットですが、各エントリの先頭に自動的に "ROLE_" が付きます。これは次を意味します。builder.roles("USER","ADMIN");
はbuilder.authorities("ROLE_USER","ROLE_ADMIN");
と同等ですこの属性は必須ですが、
authorities(String...)
を入力することもできます。- パラメーター:
roles
- このユーザーのロール(つまり、USER、ADMIN など)。null、null 値を含むこと、または "ROLE_" で始まることはできません- 戻り値:
- メソッド連鎖のための
User.UserBuilder
(つまり、このユーザーの追加属性を設定します)
authorities
public User.UserBuilder authorities(GrantedAuthority... authorities)
権限に居住します。この属性は必須です。- パラメーター:
authorities
- このユーザーの権限。null、または null 値を含めることはできません- 戻り値:
- メソッド連鎖のための
User.UserBuilder
(つまり、このユーザーの追加属性を設定します) - 関連事項:
roles(String...)
authorities
public User.UserBuilder authorities(java.util.Collection<? extends GrantedAuthority> authorities)
権限に居住します。この属性は必須です。- パラメーター:
authorities
- このユーザーの権限。null、または null 値を含めることはできません- 戻り値:
- メソッド連鎖のための
User.UserBuilder
(つまり、このユーザーの追加属性を設定します) - 関連事項:
roles(String...)
authorities
public User.UserBuilder authorities(java.lang.String... authorities)
権限に居住します。この属性は必須です。- パラメーター:
authorities
- このユーザーの権限(ROLE_USER、ROLE_ADMIN など)。null、または null 値を含めることはできません- 戻り値:
- メソッド連鎖のための
User.UserBuilder
(つまり、このユーザーの追加属性を設定します) - 関連事項:
roles(String...)
accountExpired
public User.UserBuilder accountExpired(boolean accountExpired)
アカウントが期限切れかどうかを定義します。デフォルトは false です。- パラメーター:
accountExpired
- アカウントの有効期限が切れている場合は true、そうでない場合は false- 戻り値:
- メソッド連鎖のための
User.UserBuilder
(つまり、このユーザーの追加属性を設定します)
accountLocked
public User.UserBuilder accountLocked(boolean accountLocked)
アカウントがロックされているかどうかを定義します。デフォルトは false です。- パラメーター:
accountLocked
- アカウントがロックされている場合は true、そうでない場合は false- 戻り値:
- メソッド連鎖のための
User.UserBuilder
(つまり、このユーザーの追加属性を設定します)
credentialsExpired
public User.UserBuilder credentialsExpired(boolean credentialsExpired)
資格情報が期限切れかどうかを定義します。デフォルトは false です。- パラメーター:
credentialsExpired
- 資格情報が期限切れの場合は true、そうでない場合は false- 戻り値:
- メソッド連鎖のための
User.UserBuilder
(つまり、このユーザーの追加属性を設定します)
disabled
public User.UserBuilder disabled(boolean disabled)
アカウントが無効かどうかを定義します。デフォルトは false です。- パラメーター:
disabled
- アカウントが無効な場合は true、そうでない場合は false- 戻り値:
- メソッド連鎖のための
User.UserBuilder
(つまり、このユーザーの追加属性を設定します)
build
public UserDetails build()