org.picketlink.config

Class IdentityBeanConfigurationBuilder

java.lang.Object

org.picketlink.idm.config.Builder<T>

org.picketlink.config.AbstractSecurityConfigurationBuilder<IdentityBeanConfiguration>

org.picketlink.config.IdentityBeanConfigurationBuilder

All Implemented Interfaces:

SecurityConfigurationChildBuilder

public class IdentityBeanConfigurationBuilder
extends AbstractSecurityConfigurationBuilder<IdentityBeanConfiguration>

A configuration builder with covenience methods to configure the behavior of the Identity bean.

Author:

Pedro Igor

Constructor Summary

Constructors

Constructor and Description
IdentityBeanConfigurationBuilder(SecurityConfigurationBuilder builder)

Method Summary

Methods

Modifier and Type	Method and Description
protected IdentityBeanConfiguration	create() Creates a new configuration.
protected Builder<IdentityBeanConfiguration>	readFrom(IdentityBeanConfiguration fromConfiguration) Reads a pre-created configuration.
IdentityBeanConfigurationBuilder	scope(Class<? extends Annotation> scope) Sepcifies the scope of the Identity bean.
IdentityBeanConfigurationBuilder	stateless() Enables the stateless mode of the Identity bean.
protected void	validate() Validates the internal state.

Methods inherited from class org.picketlink.config.AbstractSecurityConfigurationBuilder

build, http, identity, idmConfig

Methods inherited from class java.lang.Object

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

Constructor Detail

IdentityBeanConfigurationBuilder

public IdentityBeanConfigurationBuilder(SecurityConfigurationBuilder builder)

Method Detail

stateless

public IdentityBeanConfigurationBuilder stateless()

Enables the stateless mode of the Identity bean. In this case, the bean will be RequestScoped.

Default is false.

Returns:

scope

public IdentityBeanConfigurationBuilder scope(Class<? extends Annotation> scope)

Sepcifies the scope of the Identity bean.

Parameters:

scope - The scope of the identity bean. It can not be null.

Returns:

create

protected IdentityBeanConfiguration create()
                                    throws SecurityConfigurationException

Description copied from class: Builder

Creates a new configuration.

Overrides:

create in class AbstractSecurityConfigurationBuilder<IdentityBeanConfiguration>

Returns:

Throws:

SecurityConfigurationException - if any error occurs or for any invalid configuration

validate

protected void validate()
                 throws SecurityConfigurationException

Description copied from class: Builder

Validates the internal state.

Overrides:

validate in class AbstractSecurityConfigurationBuilder<IdentityBeanConfiguration>

Throws:

SecurityConfigurationException - if any error occurs or for any invalid configuration

readFrom

protected Builder<IdentityBeanConfiguration> readFrom(IdentityBeanConfiguration fromConfiguration)
                                               throws SecurityConfigurationException

Description copied from class: Builder

Reads a pre-created configuration.

Overrides:

readFrom in class AbstractSecurityConfigurationBuilder<IdentityBeanConfiguration>

Returns:

Throws:

SecurityConfigurationException - if any error occurs or for any invalid configuration