com.xdev.security.authorization

Interface RoleBuilder

All Known Implementing Classes:

RoleBuilder.Implementation

public interface RoleBuilder

A builder pattern utility type that allows more a flexible and ergonomical assembly of Role instances than using a constructor method directly.

Author:

XDEV Software (TM)

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RoleBuilder.Implementation A simple RoleBuilder default implementation.

Method Summary

Modifier and Type	Method and Description
default Role	build() Builds a Role instance from the assembly data currently available to the builder instance and then resets the builder internally.
Role	buildUnresetted() Builds a Role by creating a new instance of that type, using the assembly data currently available to the builder instance.
RoleBuilder	grant(Permission permission)
RoleBuilder	grant(Role role)
String	name()
RoleBuilder	name(String name)
static RoleBuilder	New(RoleManager roleManager) Creates a new RoleBuilder instance connected to be passed RoleManager, using a Role.Creator default implementation.
static RoleBuilder	New(RoleManager roleManager, Role.Creator roleCreator) Creates a new RoleBuilder instance connected to be passed RoleManager, using the passed Role.Creator instance.
Collection<? extends Permission>	permissions()
RoleBuilder	permissions(Collection<? extends Permission> permissions)
RoleBuilder	reset() Resets this RoleBuilder instance's internal state to default values (effectively "clearing" the state).
Collection<? extends Role>	roles()
RoleBuilder	roles(Collection<? extends Role> roles)

Method Detail

name

String name()

roles

Collection<? extends Role> roles()

permissions

Collection<? extends Permission> permissions()

name

RoleBuilder name(String name)

grant

RoleBuilder grant(Role role)

grant

RoleBuilder grant(Permission permission)

roles

RoleBuilder roles(Collection<? extends Role> roles)

permissions

RoleBuilder permissions(Collection<? extends Permission> permissions)

reset

RoleBuilder reset()

Resets this RoleBuilder instance's internal state to default values (effectively "clearing" the state).

Returns:

this.

buildUnresetted

Role buildUnresetted()

Builds a Role by creating a new instance of that type, using the assembly data currently available to the builder instance. The builder's internal data is NOT resetted after the instantiation is completed. This is useful if another instance with the exactely or largely the same data and maybe just little changes shall be created subsequently.

Returns:

a new Role instance built from the available data.

See Also:

build(), reset()

build

default Role build()

Builds a Role instance from the assembly data currently available to the builder instance and then resets the builder internally.

Returns:

a new Role instance built from the available data.

See Also:

buildUnresetted(), reset()

New

static RoleBuilder New(RoleManager roleManager)

Creates a new RoleBuilder instance connected to be passed RoleManager, using a Role.Creator default implementation.

Parameters:

roleManager - the RoleManager for which this builder shall build Role instances.

Returns:

a new RoleBuilder instance

New

static RoleBuilder New(RoleManager roleManager,
                       Role.Creator roleCreator)

Creates a new RoleBuilder instance connected to be passed RoleManager, using the passed Role.Creator instance.

Parameters:

roleManager - the RoleManager for which this builder shall build Role instances.

roleCreator - the Role.Creator instance to be used for creating new Role instances.

Returns:

a new RoleBuilder instance