SecurityExpressionRoot (spring-security-docs-manual 5.3.2.RELEASE API)

java.lang.Object
- org.springframework.security.access.expression.SecurityExpressionRoot

実装済みのインターフェース一覧:
SecurityExpressionOperations
既知の直属サブクラス
MessageSecurityExpressionRoot, WebSecurityExpressionRoot
```
public abstract class SecurityExpressionRoot
extends java.lang.Object
implements SecurityExpressionOperations
```
Spring Security 式の評価で使用するベースルートオブジェクト。
導入:
3.0

フィールド概要

フィールド
修飾子と型	フィールドと説明
`java.lang.String`	`admin`
`protected Authentication`	`authentication`
`java.lang.String`	`create`
`java.lang.String`	`delete`
`boolean`	`denyAll` "denyAll" 表現が可能
`boolean`	`permitAll` "permitAll" 表現が可能
`java.lang.String`	`read`
`java.lang.String`	`write`

コンストラクター概要
コンストラクター
コンストラクターと説明
SecurityExpressionRoot(Authentication authentication)
新しいインスタンスを作成します

コンストラクター
コンストラクターと説明
`SecurityExpressionRoot(Authentication authentication)` 新しいインスタンスを作成します

方法の概要

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`boolean`	`denyAll()` 常にアクセスを拒否する
`Authentication`	`getAuthentication()` 式の評価に使用される `Authentication` を取得します
`java.lang.Object`	`getPrincipal()` `getAuthentication()` から `Authentication.getPrincipal()` にアクセスするための便利なメソッド
`boolean`	`hasAnyAuthority(java.lang.String... authorities)` `SecurityExpressionOperations.getAuthentication()` が `Authentication.getAuthorities()` 内に指定された権限のいずれかを持っているかどうかを判別します。
`boolean`	`hasAnyRole(java.lang.String... roles)` `SecurityExpressionOperations.getAuthentication()` が `Authentication.getAuthorities()` 内に指定された権限のいずれかを持っているかどうかを判別します。
`boolean`	`hasAuthority(java.lang.String authority)` `SecurityExpressionOperations.getAuthentication()` が `Authentication.getAuthorities()` 内に特定の権限を持っているかどうかを判別します。
`boolean`	`hasPermission(java.lang.Object target, java.lang.Object permission)` `SecurityExpressionOperations.getAuthentication()` に、許可が与えられたターゲットへのアクセス許可があるかどうかを判別します
`boolean`	`hasPermission(java.lang.Object targetId, java.lang.String targetType, java.lang.Object permission)` `SecurityExpressionOperations.getAuthentication()` に、指定された ID、型、許可を持つドメインオブジェクトにアクセスする許可があるかどうかを判別します。
`boolean`	`hasRole(java.lang.String role)` `SecurityExpressionOperations.getAuthentication()` が `Authentication.getAuthorities()` 内に特定の権限を持っているかどうかを判別します。
`boolean`	`isAnonymous()` `SecurityExpressionOperations.getAuthentication()` が匿名かどうかを判別します
`boolean`	`isAuthenticated()` `SecurityExpressionOperations.getAuthentication()` が認証されているかどうかを判別します
`boolean`	`isFullyAuthenticated()` `SecurityExpressionOperations.getAuthentication()` が、私を記憶せずに認証されたかどうかを判別します
`boolean`	`isRememberMe()` `SecurityExpressionOperations.getAuthentication()` が Remember Me を使用して認証されたかどうかを判別します
`boolean`	`permitAll()` 常にアクセスを許可します。
`void`	`setDefaultRolePrefix(java.lang.String defaultRolePrefix)` `hasAnyRole(String...)` または `hasRole(String)` に追加されるデフォルトのプレフィックスを設定します。
`void`	`setPermissionEvaluator(PermissionEvaluator permissionEvaluator)`
`void`	`setRoleHierarchy(RoleHierarchy roleHierarchy)`
`void`	`setTrustResolver(AuthenticationTrustResolver trustResolver)`

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

- フィールドの詳細
  - authentication
```
protected final Authentication authentication
```
  - permitAll
```
public final boolean permitAll
```
    "permitAll" 表現が可能
    関連事項:
    定数フィールド値
  - denyAll
```
public final boolean denyAll
```
    "denyAll" 表現が可能
    関連事項:
    定数フィールド値
  - read
```
public final java.lang.String read
```
    関連事項:
    定数フィールド値
  - write
```
public final java.lang.String write
```
    関連事項:
    定数フィールド値
  - create
```
public final java.lang.String create
```
    関連事項:
    定数フィールド値
  - delete
```
public final java.lang.String delete
```
    関連事項:
    定数フィールド値
  - admin
```
public final java.lang.String admin
```
    関連事項:
    定数フィールド値
- コンストラクターの詳細
  - SecurityExpressionRoot
```
public SecurityExpressionRoot(Authentication authentication)
```
    新しいインスタンスを作成します
    パラメーター:
    authentication - 使用する Authentication。null にはできません。
- メソッドの詳細
  - hasAuthority
```
public final boolean hasAuthority(java.lang.String authority)
```
    インターフェースからコピーされた説明: SecurityExpressionOperations
    SecurityExpressionOperations.getAuthentication() が Authentication.getAuthorities() 内に特定の権限を持っているかどうかを判別します。
    次で指定:
    インターフェース SecurityExpressionOperations 内の hasAuthority
    パラメーター:
    authority - テストする権限 (例: "ROLE_USER" )
    戻り値:
    権限が見つかった場合は true、そうでない場合は false
  - hasAnyAuthority
```
public final boolean hasAnyAuthority(java.lang.String... authorities)
```
    インターフェースからコピーされた説明: SecurityExpressionOperations
    SecurityExpressionOperations.getAuthentication() が Authentication.getAuthorities() 内に指定された権限のいずれかを持っているかどうかを判別します。
    次で指定:
    インターフェース SecurityExpressionOperations 内の hasAnyAuthority
    パラメーター:
    authorities - テストする権限 (例: "ROLE_USER" ,"ROLE_ADMIN" )
    戻り値:
    いずれかのオーソリティが見つかった場合は true、そうでない場合は false
  - hasRole
```
public final boolean hasRole(java.lang.String role)
```
    インターフェースからコピーされた説明: SecurityExpressionOperations
    SecurityExpressionOperations.getAuthentication() が Authentication.getAuthorities() 内に特定の権限を持っているかどうかを判別します。
    これは SecurityExpressionOperations.hasAuthority(String) に似ていますが、このメソッドは渡された文字列がロールであることを暗示しています。例: "USER" が実装に渡された場合、代わりに "ROLE_USER" を使用するように変換できます。ロールが変換される方法は、実装設定によって異なります。
    次で指定:
    インターフェース SecurityExpressionOperations 内の hasRole
    パラメーター:
    role - テストする権限 (例: "USER" )
    戻り値:
    権限が見つかった場合は true、そうでない場合は false
  - hasAnyRole
```
public final boolean hasAnyRole(java.lang.String... roles)
```
    インターフェースからコピーされた説明: SecurityExpressionOperations
    SecurityExpressionOperations.getAuthentication() が Authentication.getAuthorities() 内に指定された権限のいずれかを持っているかどうかを判別します。
    これは hasAnyAuthority に似ていますが、このメソッドは渡された文字列がロールであることを意味します。例: "USER" が渡された場合、実装では代わりに "ROLE_USER" を使用するように変換される場合があります。ロールの変換方法は、実装設定によって異なります。
    次で指定:
    インターフェース SecurityExpressionOperations 内の hasAnyRole
    パラメーター:
    roles - テストする権限 (例: "USER" ,"ADMIN" )
    戻り値:
    いずれかのオーソリティが見つかった場合は true、そうでない場合は false
  - getAuthentication
```
public final Authentication getAuthentication()
```
    インターフェースからコピーされた説明: SecurityExpressionOperations
    式の評価に使用される Authentication を取得します
    次で指定:
    インターフェース SecurityExpressionOperations 内の getAuthentication
    戻り値:
    式を評価するための Authentication
  - permitAll
```
public final boolean permitAll()
```
    インターフェースからコピーされた説明: SecurityExpressionOperations
    常にアクセスを許可します。
    次で指定:
    インターフェース SecurityExpressionOperations 内の permitAll
    戻り値:
    true
  - denyAll
```
public final boolean denyAll()
```
    インターフェースからコピーされた説明: SecurityExpressionOperations
    常にアクセスを拒否する
    次で指定:
    インターフェース SecurityExpressionOperations 内の denyAll
    戻り値:
    false
  - isAnonymous
```
public final boolean isAnonymous()
```
    インターフェースからコピーされた説明: SecurityExpressionOperations
    SecurityExpressionOperations.getAuthentication() が匿名かどうかを判別します
    次で指定:
    インターフェース SecurityExpressionOperations 内の isAnonymous
    戻り値:
    ユーザーが匿名の場合は true、それ以外の場合は false
  - isAuthenticated
```
public final boolean isAuthenticated()
```
    インターフェースからコピーされた説明: SecurityExpressionOperations
    SecurityExpressionOperations.getAuthentication() が認証されているかどうかを判別します
    次で指定:
    インターフェース SecurityExpressionOperations 内の isAuthenticated
    戻り値:
    SecurityExpressionOperations.getAuthentication() が認証されている場合は true、そうでない場合は false
  - isRememberMe
```
public final boolean isRememberMe()
```
    インターフェースからコピーされた説明: SecurityExpressionOperations
    SecurityExpressionOperations.getAuthentication() が Remember Me を使用して認証されたかどうかを判別します
    次で指定:
    インターフェース SecurityExpressionOperations 内の isRememberMe
    戻り値:
    SecurityExpressionOperations.getAuthentication() が認証情報を使用して認証されている場合は true、それ以外の場合は false
  - isFullyAuthenticated
```
public final boolean isFullyAuthenticated()
```
    インターフェースからコピーされた説明: SecurityExpressionOperations
    SecurityExpressionOperations.getAuthentication() が、私を記憶せずに認証されたかどうかを判別します
    次で指定:
    インターフェース SecurityExpressionOperations 内の isFullyAuthenticated
    戻り値:
    SecurityExpressionOperations.getAuthentication() が認証情報を使用せずに認証された場合は true、それ以外の場合は false
  - getPrincipal
```
public java.lang.Object getPrincipal()
```
    getAuthentication() から Authentication.getPrincipal() にアクセスするための便利なメソッド
    戻り値:
  - setTrustResolver
```
public void setTrustResolver(AuthenticationTrustResolver trustResolver)
```
  - setRoleHierarchy
```
public void setRoleHierarchy(RoleHierarchy roleHierarchy)
```
  - setDefaultRolePrefix
```
public void setDefaultRolePrefix(java.lang.String defaultRolePrefix)
```
    hasAnyRole(String...) または hasRole(String) に追加するデフォルトのプレフィックスを設定します。例: hasRole("ADMIN" ) または hasRole("ROLE_ADMIN" ) が渡された場合、defaultRolePrefix が "ROLE_" (デフォルト) のときはロール ROLE_ADMIN が使用されます。
    null または空の場合、デフォルトのロールプレフィックスは使用されません。
    パラメーター:
    defaultRolePrefix - ロールに追加するデフォルトのプレフィックス。デフォルトは "ROLE_"。
  - hasPermission
```
public boolean hasPermission(java.lang.Object target,
                             java.lang.Object permission)
```
    インターフェースからコピーされた説明: SecurityExpressionOperations
    SecurityExpressionOperations.getAuthentication() に、許可が与えられたターゲットへのアクセス許可があるかどうかを判別します
    次で指定:
    インターフェース SecurityExpressionOperations 内の hasPermission
    パラメーター:
    target - 権限を確認するターゲットドメインオブジェクト
    permission - ドメインオブジェクトをチェックする権限 ("read" ,"write" など)。
    戻り値:
    SecurityExpressionOperations.getAuthentication() に権限が付与されている場合は true、そうでない場合は false
  - hasPermission
```
public boolean hasPermission(java.lang.Object targetId,
                             java.lang.String targetType,
                             java.lang.Object permission)
```
    インターフェースからコピーされた説明: SecurityExpressionOperations
    SecurityExpressionOperations.getAuthentication() に、指定された ID、型、許可を持つドメインオブジェクトにアクセスする許可があるかどうかを判別します。
    次で指定:
    インターフェース SecurityExpressionOperations 内の hasPermission
    パラメーター:
    targetId - アクセスを決定するドメインオブジェクトの識別子
    targetType - 型 (つまり、com.example.domain.Message)
    permission - ドメインオブジェクトをチェックする権限 (例: "read" ,"write" など)
    戻り値:
    SecurityExpressionOperations.getAuthentication() に権限が付与されている場合は true、そうでない場合は false
  - setPermissionEvaluator
```
public void setPermissionEvaluator(PermissionEvaluator permissionEvaluator)
```

クラス SecurityExpressionRoot

フィールド概要

コンストラクター概要

方法の概要

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

フィールドの詳細

authentication

permitAll

denyAll

read

write

create

delete

admin

コンストラクターの詳細

SecurityExpressionRoot

メソッドの詳細

hasAuthority

hasAnyAuthority

hasRole

hasAnyRole

getAuthentication

permitAll

denyAll

isAnonymous

isAuthenticated

isRememberMe

isFullyAuthenticated

getPrincipal

setTrustResolver

setRoleHierarchy

setDefaultRolePrefix

hasPermission

hasPermission

setPermissionEvaluator