PolicyConfig (Quarkus - Vert.x - HTTP - Runtime 3.3.0 API)

java.lang.Object
- io.quarkus.vertx.http.runtime.PolicyConfig

public class PolicyConfig
extends Object

Field Summary

Fields
Modifier and Type	Field	Description
`String`	`permissionClass`	Permissions granted by this policy will be created with a `java.security.Permission` implementation specified by this configuration property.
`Map<String,List<String>>`	`permissions`	Permissions granted to the `SecurityIdentity` if this policy is applied successfully (the policy allows request to proceed) and the authenticated request has required role.
`List<String>`	`rolesAllowed`	The roles that are allowed to access resources protected by this policy.

Constructor Summary

Constructors
Constructor Description

PolicyConfig()

Method Summary
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - rolesAllowed
```
@ConfigItem(defaultValue="**")
@ConvertWith(io.quarkus.runtime.configuration.TrimmedStringConverter.class)
public List<String> rolesAllowed
```
    The roles that are allowed to access resources protected by this policy. By default, access is allowed to any authenticated user.
  - permissions
```
@ConfigDocMapKey("role1")
@ConfigItem
public Map<String,List<String>> permissions
```
    Permissions granted to the `SecurityIdentity` if this policy is applied successfully (the policy allows request to proceed) and the authenticated request has required role. For example, you can map permission `perm1` with actions `action1` and `action2` to role `admin` by setting `quarkus.http.auth.policy.role-policy1.permissions.admin=perm1:action1,perm1:action2` configuration property. Granted permissions are used for authorization with the `@PermissionsAllowed` annotation.
  - permissionClass
```
@ConfigItem(defaultValue="io.quarkus.security.StringPermission")
public String permissionClass
```
    Permissions granted by this policy will be created with a `java.security.Permission` implementation specified by this configuration property. The permission class must declare exactly one constructor that accepts permission name (`String`) or permission name and actions (`String`, `String[]`).
- Constructor Detail
  - PolicyConfig
```
public PolicyConfig()
```