senselogic.sitevision.api.security

Interface RoleAssignmentBuilder

All Superinterfaces:

Builder<RoleAssignment>

@Requireable(value="RoleAssignmentBuilder")
public interface RoleAssignmentBuilder
extends Builder<RoleAssignment>

Builder of RoleAssignment instances.

Tip! The Builder interface documentation contains more information about Builders and how to work with them!

An instance of the Sitevision class implementing this interface can be obtained via RoleUtil.getRoleAssignmentBuilder(). See RoleUtil for how to obtain an instance of the RoleUtil interface.

Since:

Sitevision 5.1

Author:

Magnus Lövgren

See Also:

RoleAssignment

Method Summary

Modifier and Type	Method and Description
RoleAssignment	build() Creates a read-only RoleAssignment instance using current state of this builder.
RoleAssignmentBuilder	clear() Clears the state of this builder.
RoleAssignmentBuilder	setPrincipal(Node aPrincipal) Sets the principal (sv:user, sv:simpleUser, sv:userGroup or sv:virtualGroup).
RoleAssignmentBuilder	setRole(Node aRole) Sets the role (sv:role).

Method Detail

setPrincipal

RoleAssignmentBuilder setPrincipal(Node aPrincipal)

Sets the principal (sv:user, sv:simpleUser, sv:userGroup or sv:virtualGroup).

Parameters:

aPrincipal - the principal

Returns:

this builder

setRole

RoleAssignmentBuilder setRole(Node aRole)

Sets the role (sv:role).

Parameters:

aRole - the role

Returns:

this builder

clear

RoleAssignmentBuilder clear()

Clears the state of this builder.

Sets the principal and the role to null.

Returns:

this builder

build

RoleAssignment build()
              throws IllegalStateException

Creates a read-only RoleAssignment instance using current state of this builder.

Specified by:

build in interface Builder<RoleAssignment>

Returns:

a RoleAssignment instance

Throws:

IllegalStateException - if role and/or principal is not properly set