Package io.quarkus.security.runtime

Class QuarkusSecurityIdentity.Builder

java.lang.Object

io.quarkus.security.runtime.QuarkusSecurityIdentity.Builder

Enclosing class:

QuarkusSecurityIdentity

public static class QuarkusSecurityIdentity.Builder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Map<String,Object>	attributes
(package private) boolean	built
(package private) Set<io.quarkus.security.credential.Credential>	credentials
(package private) List<Function<Permission,io.smallrye.mutiny.Uni<Boolean>>>	permissionCheckers
(package private) Set<Permission>	permissions
(package private) Principal	principal
(package private) Set<String>	roles

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
QuarkusSecurityIdentity.Builder	addAttribute(String key, Object value)
QuarkusSecurityIdentity.Builder	addAttributes(Map<String,Object> attributes)
QuarkusSecurityIdentity.Builder	addCredential(io.quarkus.security.credential.Credential credential)
QuarkusSecurityIdentity.Builder	addCredentials(Set<io.quarkus.security.credential.Credential> credentials)
QuarkusSecurityIdentity.Builder	addPermission(Permission permission)	Adds a permission.
QuarkusSecurityIdentity.Builder	addPermissionAsString(String permission)	Adds a permission as String.
QuarkusSecurityIdentity.Builder	addPermissionChecker(Function<Permission,io.smallrye.mutiny.Uni<Boolean>> function)	Adds a permission checker function.
QuarkusSecurityIdentity.Builder	addPermissionCheckers(List<Function<Permission,io.smallrye.mutiny.Uni<Boolean>>> functions)	Adds a permission check functions.
QuarkusSecurityIdentity.Builder	addPermissions(Set<Permission> permissions)	Adds permissions.
QuarkusSecurityIdentity.Builder	addPermissionsAsString(Set<String> permissions)	Adds permissions as String
QuarkusSecurityIdentity.Builder	addRole(String role)
QuarkusSecurityIdentity.Builder	addRoles(Set<String> roles)
QuarkusSecurityIdentity	build()
QuarkusSecurityIdentity.Builder	setAnonymous(boolean anonymous)	Sets an anonymous identity status.
QuarkusSecurityIdentity.Builder	setPrincipal(Principal principal)
(package private) static Permission	toPermission(String permissionAsString)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

principal

Principal principal

roles

Set<String> roles

credentials

Set<io.quarkus.security.credential.Credential> credentials

permissions

Set<Permission> permissions

attributes

Map<String,Object> attributes

permissionCheckers

List<Function<Permission,io.smallrye.mutiny.Uni<Boolean>>> permissionCheckers

built

boolean built

Constructor Details

Builder

public Builder()

Method Details

setPrincipal

public QuarkusSecurityIdentity.Builder setPrincipal(Principal principal)

addRole

public QuarkusSecurityIdentity.Builder addRole(String role)

addRoles

public QuarkusSecurityIdentity.Builder addRoles(Set<String> roles)

addCredential

public QuarkusSecurityIdentity.Builder addCredential(io.quarkus.security.credential.Credential credential)

addCredentials

public QuarkusSecurityIdentity.Builder addCredentials(Set<io.quarkus.security.credential.Credential> credentials)

addAttribute

public QuarkusSecurityIdentity.Builder addAttribute(String key,
 Object value)

addAttributes

public QuarkusSecurityIdentity.Builder addAttributes(Map<String,Object> attributes)

addPermissionAsString

public QuarkusSecurityIdentity.Builder addPermissionAsString(String permission)

Adds a permission as String.

Parameters:

permission - The permission in a String format.

Returns:

This builder

addPermissionsAsString

public QuarkusSecurityIdentity.Builder addPermissionsAsString(Set<String> permissions)

Adds permissions as String

Parameters:

permissions - The permissions in a String format.

Returns:

This builder

addPermission

public QuarkusSecurityIdentity.Builder addPermission(Permission permission)

Adds a permission.

Parameters:

permission - The permission

Returns:

This builder

addPermissions

public QuarkusSecurityIdentity.Builder addPermissions(Set<Permission> permissions)

Adds permissions.

Parameters:

permissions - The permissions

Returns:

This builder

addPermissionChecker

public QuarkusSecurityIdentity.Builder addPermissionChecker(Function<Permission,io.smallrye.mutiny.Uni<Boolean>> function)

Adds a permission checker function. This permission checker has the following semantics: If it returns null, or the CompletionStage evaluates to null then this check is ignored If every function returns null or false then the check is failed If any function returns true the check passes

Parameters:

function - The permission checker function

Returns:

This builder

addPermissionCheckers

public QuarkusSecurityIdentity.Builder addPermissionCheckers(List<Function<Permission,io.smallrye.mutiny.Uni<Boolean>>> functions)

Adds a permission check functions.

Parameters:

functions - The permission check functions

Returns:

This builder

See Also:

• addPermissionChecker(Function)

setAnonymous

public QuarkusSecurityIdentity.Builder setAnonymous(boolean anonymous)

Sets an anonymous identity status.

Parameters:

anonymous - the anonymous status

Returns:

This builder

build

public QuarkusSecurityIdentity build()

toPermission

static Permission toPermission(String permissionAsString)