Class GlobalRoleConfigurationBuilder

java.lang.Object

org.infinispan.configuration.global.AbstractGlobalConfigurationBuilder

org.infinispan.configuration.global.GlobalRoleConfigurationBuilder

All Implemented Interfaces:

Builder<Role>, GlobalConfigurationChildBuilder, GlobalRolesConfigurationChildBuilder

public class GlobalRoleConfigurationBuilder
extends AbstractGlobalConfigurationBuilder
implements GlobalRolesConfigurationChildBuilder, Builder<Role>

GlobalRoleConfigurationBuilder.

Since:

7.0

Author:

Tristan Tarrant

Constructor Summary

Constructors

Constructor	Description
GlobalRoleConfigurationBuilder(String name, GlobalAuthorizationConfigurationBuilder builder)

Method Summary

Modifier and Type	Method	Description
AttributeSet	attributes()
Role	create()	Create the configuration bean
GlobalRoleConfigurationBuilder	description(String description)	A description for the role
GlobalRoleConfigurationBuilder	inheritable(boolean inheritable)	Whether this role should be implicitly inherited by secure caches which don't define their roles.
GlobalRoleConfigurationBuilder	permission(String permission)	Adds a permission to a role
GlobalRoleConfigurationBuilder	permission(String... permissions)	Adds multiple permissions to a role
GlobalRoleConfigurationBuilder	permission(AuthorizationPermission permission)	Adds a permission to a role
GlobalRoleConfigurationBuilder	permission(AuthorizationPermission... permissions)	Adds multiple permissions to a role
Builder<?>	read(Role template, Combine combine)	Reads the configuration from an already created configuration bean into this builder.
GlobalRoleConfigurationBuilder	role(String name)

Methods inherited from class org.infinispan.configuration.global.AbstractGlobalConfigurationBuilder

addModule, asyncThreadPool, blockingThreadPool, build, clearModules, defaultCacheName, expirationThreadPool, getGlobalConfig, globalState, jmx, listenerThreadPool, metrics, module, modules, nonBlockingThreadPool, persistenceThreadPool, security, serialization, shutdown, site, tracing, transport

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.commons.configuration.Builder

read, reset, validate

Constructor Details

GlobalRoleConfigurationBuilder

public GlobalRoleConfigurationBuilder(String name,
 GlobalAuthorizationConfigurationBuilder builder)

Method Details

attributes

public AttributeSet attributes()

Specified by:

attributes in interface Builder<Role>

permission

public GlobalRoleConfigurationBuilder permission(String permission)

Adds a permission to a role

Parameters:

permission - the name of the permission to add to the role. See AuthorizationPermission

permission

public GlobalRoleConfigurationBuilder permission(String... permissions)

Adds multiple permissions to a role

Parameters:

permissions - the name of the permissions to add to the role. See AuthorizationPermission

permission

public GlobalRoleConfigurationBuilder permission(AuthorizationPermission permission)

Adds a permission to a role

Parameters:

permission - the permission to add to the role. See AuthorizationPermission

permission

public GlobalRoleConfigurationBuilder permission(AuthorizationPermission... permissions)

Adds multiple permissions to a role

Parameters:

permissions - the permissions to add to the role. See AuthorizationPermission

role

public GlobalRoleConfigurationBuilder role(String name)

Specified by:

role in interface GlobalRolesConfigurationChildBuilder

inheritable

public GlobalRoleConfigurationBuilder inheritable(boolean inheritable)

Whether this role should be implicitly inherited by secure caches which don't define their roles.

Specified by:

inheritable in interface GlobalRolesConfigurationChildBuilder

Parameters:

inheritable -

Returns:

description

public GlobalRoleConfigurationBuilder description(String description)

A description for the role

Specified by:

description in interface GlobalRolesConfigurationChildBuilder

Parameters:

description -

Returns:

create

public Role create()

Description copied from interface: Builder

Create the configuration bean

Specified by:

create in interface Builder<Role>

Returns:

read

public Builder<?> read(Role template,
 Combine combine)

Description copied from interface: Builder

Reads the configuration from an already created configuration bean into this builder. Returns an appropriate builder to allow fluent configuration

Specified by:

read in interface Builder<Role>

Parameters:

template - the configuration from which to "clone" this config if needed.

combine - the way attributes and children of this instance and the template should be combined.