org.uberfire.security.client.authz.tree

Interface PermissionTreeProvider

public interface PermissionTreeProvider

A PermissionTree is composed by a list of root nodes. The classes implementing this interface are used by the PermissionTreeFactory to build those root nodes.

From application perspective, custom tree providers can be implemented in order to make application related permissions part of the permission tree.

Method Summary

Modifier and Type	Method and Description
PermissionNode	buildRootNode() Returns a brand new node containing a permission node hierarchy.
default boolean	isActive() Flag indicating if this provider is in active state.
void	loadChildren(PermissionNode parent, LoadOptions options, LoadCallback consumer) Asynchronous interface for loading the children nodes of a given parent permission node.

Method Detail

buildRootNode

PermissionNode buildRootNode()

Returns a brand new node containing a permission node hierarchy.

Returns:

A completely initialized PermissionNode instance.

loadChildren

void loadChildren(PermissionNode parent,
                  LoadOptions options,
                  LoadCallback consumer)

Asynchronous interface for loading the children nodes of a given parent permission node.

Parameters:

parent - The parent node

options - The load options

consumer - The callback instance to notify once the loading process is done.

isActive

default boolean isActive()

Flag indicating if this provider is in active state.

Only if active, its root node is added to the permission tree.