AuthorizationConfigurationBuilder (Red Hat JBoss Enterprise Application Platform 7.4.0.GA public API)

java.lang.Object
- org.infinispan.configuration.cache.AuthorizationConfigurationBuilder

All Implemented Interfaces:

BaseConfigurationInfo, Builder<AuthorizationConfiguration>, ConfigurationBuilderInfo, ConfigurationChildBuilder, SecurityConfigurationChildBuilder
```
public class AuthorizationConfigurationBuilder
extends Object
implements Builder<AuthorizationConfiguration>, ConfigurationBuilderInfo
```
AuthorizationConfigurationBuilder.

Since:

7.0

Author:

Tristan Tarrant

Field Summary

Fields
Modifier and Type Field and Description

protected ConfigurationBuilder builder

Fields
Modifier and Type	Field and Description
`protected ConfigurationBuilder`	`builder`

Constructor Summary

Constructors
Constructor and Description

AuthorizationConfigurationBuilder(SecurityConfigurationBuilder securityBuilder)

Constructors
Constructor and Description
`AuthorizationConfigurationBuilder(SecurityConfigurationBuilder securityBuilder)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`AttributeSet`	`attributes()`
`AuthorizationConfigurationBuilder`	`authorization()`
`Configuration`	`build()`
`ClusteringConfigurationBuilder`	`clustering()`
`AuthorizationConfiguration`	`create()` Create the configuration bean
`CustomInterceptorsConfigurationBuilder`	`customInterceptors()` Deprecated. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
`AuthorizationConfigurationBuilder`	`disable()` Disables authorization for this cache
`AuthorizationConfigurationBuilder`	`enable()` Enables authorization for this cache.
`AuthorizationConfigurationBuilder`	`enabled(boolean enabled)` Enables/disables authorization for this cache.
`EncodingConfigurationBuilder`	`encoding()`
`ExpirationConfigurationBuilder`	`expiration()`
`protected ConfigurationBuilder`	`getBuilder()`
`ElementDefinition`	`getElementDefinition()`
`protected SecurityConfigurationBuilder`	`getSecurityBuilder()`
`IndexingConfigurationBuilder`	`indexing()`
`InvocationBatchingConfigurationBuilder`	`invocationBatching()`
`LockingConfigurationBuilder`	`locking()`
`MemoryConfigurationBuilder`	`memory()`
`PersistenceConfigurationBuilder`	`persistence()`
`Builder<?>`	`read(AuthorizationConfiguration template)` Reads the configuration from an already created configuration bean into this builder.
`AuthorizationConfigurationBuilder`	`role(String name)` Adds a role that can work with this cache.
`AuthorizationConfigurationBuilder`	`roles(String... names)` Adds roles that can work with this cache.
`SecurityConfigurationBuilder`	`security()`
`boolean`	`simpleCache()`
`ConfigurationChildBuilder`	`simpleCache(boolean simpleCache)`
`SitesConfigurationBuilder`	`sites()`
`StatisticsConfigurationBuilder`	`statistics()`
`ConfigurationChildBuilder`	`template(boolean template)`
`String`	`toString()`
`TransactionConfigurationBuilder`	`transaction()`
`UnsafeConfigurationBuilder`	`unsafe()`
`void`	`validate()` Validate the data in this builder before building the configuration bean
`void`	`validate(GlobalConfiguration globalConfig)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.infinispan.commons.configuration.ConfigurationBuilderInfo
getBuilderInfo, getChildrenInfo, getNewBuilderInfo

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder
build, clustering, customInterceptors, encoding, expiration, indexing, invocationBatching, jmxStatistics, locking, memory, persistence, security, simpleCache, simpleCache, sites, statistics, template, transaction, unsafe

- Field Detail
  - builder
```
protected final ConfigurationBuilder builder
```
- Constructor Detail
  - AuthorizationConfigurationBuilder
```
public AuthorizationConfigurationBuilder(SecurityConfigurationBuilder securityBuilder)
```
- Method Detail
  - attributes
```
public AttributeSet attributes()
```
    Specified by:
    
    attributes in interface BaseConfigurationInfo
    
    Returns:
    
    the AttributeSet declared by the configuration.
  - getElementDefinition
```
public ElementDefinition getElementDefinition()
```
    Specified by:
    
    getElementDefinition in interface BaseConfigurationInfo
    
    Returns:
    
    the ElementDefinition of the configuration.
  - disable
```
public AuthorizationConfigurationBuilder disable()
```
    Disables authorization for this cache
  - enable
```
public AuthorizationConfigurationBuilder enable()
```
    Enables authorization for this cache. If no explicit role(String) are specified, all of the global roles apply.
  - enabled
```
public AuthorizationConfigurationBuilder enabled(boolean enabled)
```
    Enables/disables authorization for this cache. If enabled and no explicit role(String) are specified, all of the global roles apply.
  - role
```
public AuthorizationConfigurationBuilder role(String name)
```
    Adds a role that can work with this cache. Roles must be declared in the GlobalAuthorizationConfigurationBuilder.
    
    Parameters:
    
    name - the name of the role
  - roles
```
public AuthorizationConfigurationBuilder roles(String... names)
```
    Adds roles that can work with this cache. Roles must be declared in the GlobalAuthorizationConfigurationBuilder.
    
    Parameters:
    
    names - the names of the roles
  - validate
```
public void validate()
```
    Description copied from interface: Builder
    
    Validate the data in this builder before building the configuration bean
    
    Specified by:
    
    validate in interface Builder<AuthorizationConfiguration>
  - validate
```
public void validate(GlobalConfiguration globalConfig)
```
    Specified by:
    
    validate in interface ConfigurationChildBuilder
  - create
```
public AuthorizationConfiguration create()
```
    Description copied from interface: Builder
    
    Create the configuration bean
    
    Specified by:
    
    create in interface Builder<AuthorizationConfiguration>
    
    Returns:
  - read
```
public Builder<?> read(AuthorizationConfiguration template)
```
    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<AuthorizationConfiguration>
    
    Parameters:
    
    template - the configuration from which to "clone" this config if needed.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getSecurityBuilder
```
protected SecurityConfigurationBuilder getSecurityBuilder()
```
  - authorization
```
public AuthorizationConfigurationBuilder authorization()
```
    Specified by:
    
    authorization in interface SecurityConfigurationChildBuilder
  - template
```
public ConfigurationChildBuilder template(boolean template)
```
    Specified by:
    
    template in interface ConfigurationChildBuilder
  - simpleCache
```
public ConfigurationChildBuilder simpleCache(boolean simpleCache)
```
    Specified by:
    
    simpleCache in interface ConfigurationChildBuilder
  - simpleCache
```
public boolean simpleCache()
```
    Specified by:
    
    simpleCache in interface ConfigurationChildBuilder
  - clustering
```
public ClusteringConfigurationBuilder clustering()
```
    Specified by:
    
    clustering in interface ConfigurationChildBuilder
  - customInterceptors
```
@Deprecated
public CustomInterceptorsConfigurationBuilder customInterceptors()
```
    Deprecated. Since 10.0, custom interceptors support will be removed and only modules will be able to define interceptors
    
    Specified by:
    
    customInterceptors in interface ConfigurationChildBuilder
  - encoding
```
public EncodingConfigurationBuilder encoding()
```
    Specified by:
    
    encoding in interface ConfigurationChildBuilder
  - expiration
```
public ExpirationConfigurationBuilder expiration()
```
    Specified by:
    
    expiration in interface ConfigurationChildBuilder
  - indexing
```
public IndexingConfigurationBuilder indexing()
```
    Specified by:
    
    indexing in interface ConfigurationChildBuilder
  - invocationBatching
```
public InvocationBatchingConfigurationBuilder invocationBatching()
```
    Specified by:
    
    invocationBatching in interface ConfigurationChildBuilder
  - statistics
```
public StatisticsConfigurationBuilder statistics()
```
    Specified by:
    
    statistics in interface ConfigurationChildBuilder
  - persistence
```
public PersistenceConfigurationBuilder persistence()
```
    Specified by:
    
    persistence in interface ConfigurationChildBuilder
  - locking
```
public LockingConfigurationBuilder locking()
```
    Specified by:
    
    locking in interface ConfigurationChildBuilder
  - security
```
public SecurityConfigurationBuilder security()
```
    Specified by:
    
    security in interface ConfigurationChildBuilder
  - transaction
```
public TransactionConfigurationBuilder transaction()
```
    Specified by:
    
    transaction in interface ConfigurationChildBuilder
  - unsafe
```
public UnsafeConfigurationBuilder unsafe()
```
    Specified by:
    
    unsafe in interface ConfigurationChildBuilder
  - sites
```
public SitesConfigurationBuilder sites()
```
    Specified by:
    
    sites in interface ConfigurationChildBuilder
  - memory
```
public MemoryConfigurationBuilder memory()
```
    Specified by:
    
    memory in interface ConfigurationChildBuilder
  - getBuilder
```
protected ConfigurationBuilder getBuilder()
```
  - build
```
public Configuration build()
```
    Specified by:
    
    build in interface ConfigurationChildBuilder

Class AuthorizationConfigurationBuilder

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.infinispan.configuration.cache.ConfigurationChildBuilder

Field Detail

builder

Constructor Detail

AuthorizationConfigurationBuilder

Method Detail

attributes

getElementDefinition

disable

enable

enabled

role

roles

validate

validate

create

read

toString

getSecurityBuilder

authorization

template

simpleCache

simpleCache

clustering

customInterceptors

encoding

expiration

indexing

invocationBatching

statistics

persistence

locking

security

transaction

unsafe

sites

memory

getBuilder

build