senselogic.sitevision.api.security

Interface RoleMatcherBuilder

All Superinterfaces:

Builder<RoleMatcher>

@Requireable(value="RoleMatcherBuilder")
public interface RoleMatcherBuilder
extends Builder<RoleMatcher>

Builder of RoleMatcher 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.getRoleMatcherBuilder(). See RoleUtil for how to obtain an instance of the RoleUtil interface.

Since:

Sitevision 6.1

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
RoleMatcherBuilder	addRole(Node aRole) Adds a role (sv:role).
RoleMatcher	build() Creates a read-only RoleMatcher instance using current state of this builder.
RoleMatcherBuilder	clear() Clears the state of this builder.
RoleMatcherBuilder	setUser(Node aUser) Sets the user (sv:user, sv:simpleUser).

Method Detail

setUser

RoleMatcherBuilder setUser(Node aUser)

Sets the user (sv:user, sv:simpleUser).

Parameters:

aUser - the user

Returns:

this builder

addRole

RoleMatcherBuilder addRole(Node aRole)

Adds a role (sv:role).

Parameters:

aRole - the role to add

Returns:

this builder

clear

RoleMatcherBuilder clear()

Clears the state of this builder.

Sets the user and the roles to null.

Returns:

this builder

build

RoleMatcher build()
           throws IllegalStateException

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

Specified by:

build in interface Builder<RoleMatcher>

Returns:

a RoleMatcher instance

Throws:

IllegalStateException - if user is not properly set or if no roles are added