Package org.jgrapes.webconsole.rbac

Class RoleConfigurator

java.lang.Object

org.jgrapes.core.internal.ComponentVertex

org.jgrapes.core.Component

org.jgrapes.webconsole.rbac.RoleConfigurator

All Implemented Interfaces:

Iterable<ComponentType>, Channel, ComponentType, Eligible, Manager

public class RoleConfigurator
extends Component

Configures roles (of type {@link ConsoleRole)} for the user currently logged in.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jgrapes.core.Channel

Channel.Default

Field Summary

Fields inherited from class org.jgrapes.core.Component

logger

Fields inherited from interface org.jgrapes.core.Channel

BROADCAST, SELF

Constructor Summary

Constructors

Constructor	Description
RoleConfigurator(Channel componentChannel)	Creates a new component with its channel set to the given channel.
RoleConfigurator(Channel componentChannel, Map<?,?> properties)	Creates a new component with its channel set to the given channel.

Method Summary

Modifier and Type	Method	Description
void	onConfigUpdate(ConfigurationUpdate event)	The component can be configured with events that include a path (see @link ConfigurationUpdate.paths()) that matches this components path (see Manager.componentPath()).
void	onConsolePrepared(ConsolePrepared event, ConsoleConnection channel)	Sets the roles in the session’s subject.
RoleConfigurator	setReplace(boolean replace)	Control whether the component replaces all ConsoleRoles or adds to the existing roles (default).
RoleConfigurator	setRolesByUser(Map<String,Set<String>> roles)	Sets the roles associated with a user.

Methods inherited from class org.jgrapes.core.Component

channel, component, defaultCriterion, isEligibleFor, setName

Methods inherited from class org.jgrapes.core.internal.ComponentVertex

activeEventPipeline, addHandler, attach, children, componentPath, componentVertex, detach, fire, initComponentsHandlers, iterator, name, newEventPipeline, newEventPipeline, parent, registerAsGenerator, root, toString, unregisterAsGenerator

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface org.jgrapes.core.Manager

stream

Constructor Details

RoleConfigurator

public RoleConfigurator(Channel componentChannel)

Creates a new component with its channel set to the given channel.

Parameters:

componentChannel - the channel that the component’s handlers listen on by default and that Manager.fire(Event, Channel...) sends the event to

RoleConfigurator

public RoleConfigurator(Channel componentChannel,
 Map<?,?> properties)

Creates a new component with its channel set to the given channel.

Supported properties are:

• rolesByUser: see setRolesByUser(Map).

Parameters:

componentChannel - the channel that the component’s handlers listen on by default and that Manager.fire(Event, Channel...) sends the event to

properties - the properties used to configure the component

Method Details

setRolesByUser

public RoleConfigurator setRolesByUser(Map<String,Set<String>> roles)

Sets the roles associated with a user.

The parameter is a Map<String, Set> holding the roles to be
associated with a given user. The special key “*” may be used to specify roles that are to be added to any user.

Parameters:

roles - the roles

Returns:

the user role conlet filter

setReplace

public RoleConfigurator setReplace(boolean replace)

Control whether the component replaces all ConsoleRoles or adds to the existing roles (default).

Parameters:

replace - the replace

Returns:

the role configurator

onConfigUpdate

@Handler
public void onConfigUpdate(ConfigurationUpdate event)

The component can be configured with events that include a path (see @link ConfigurationUpdate.paths()) that matches this components path (see Manager.componentPath()).

The following properties are recognized:

rolesByUser

Invokes setRolesByUser(Map) with the given values.

replace

Invokes setReplace(boolean) with the given value.

Parameters:

event - the event

onConsolePrepared

@Handler(priority=900)
public void onConsolePrepared(ConsolePrepared event,
 ConsoleConnection channel)

Sets the roles in the session’s subject.

The current user is obtained from WebConsoleUtils.userFromSession(org.jgrapes.http.Session).

Parameters:

event - the event

channel - the channel