org.picketlink.config

Class SecurityConfigurationBuilder

java.lang.Object

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

org.picketlink.config.SecurityConfigurationBuilder

All Implemented Interfaces:

SecurityConfigurationChildBuilder

public class SecurityConfigurationBuilder
extends Builder<SecurityConfiguration>
implements SecurityConfigurationChildBuilder

A class used to build SecurityConfiguration instances, providing a fluent API with some meaningful methods.

It can be initialized in two ways:

• Using the default constructor. In this case all the configuration must be done before invoking one of the build methods.

Author:

Pedro Igor

Constructor Summary

Constructors

Constructor and Description
SecurityConfigurationBuilder()

Method Summary

Methods

Modifier and Type	Method and Description
SecurityConfiguration	build() Builds a SecurityConfiguration instance.
protected SecurityConfiguration	create() Creates a new configuration.
HttpSecurityBuilder	http() Convenience methods to configure HTTP security.
IdentityBeanConfigurationBuilder	identity() Convenience methods to configure behavior of the Identity bean.
IdentityConfigurationBuilder	idmConfig() Convenience methods for Identity Management Configuration.
protected Builder<SecurityConfiguration>	readFrom(SecurityConfiguration fromConfiguration) Reads a pre-created configuration.
protected void	validate() Validates the internal state.

Methods inherited from class java.lang.Object

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

Constructor Detail

SecurityConfigurationBuilder

public SecurityConfigurationBuilder()

Method Detail

idmConfig

public IdentityConfigurationBuilder idmConfig()

Convenience methods for Identity Management Configuration.

Specified by:

idmConfig in interface SecurityConfigurationChildBuilder

Returns:

The builder responsible to provide all identity management configuration options.

identity

public IdentityBeanConfigurationBuilder identity()

Convenience methods to configure behavior of the Identity bean.

Specified by:

identity in interface SecurityConfigurationChildBuilder

Returns:

The builder responsible to provide the configuration options for the identity bean.

http

public HttpSecurityBuilder http()

Convenience methods to configure HTTP security.

Specified by:

http in interface SecurityConfigurationChildBuilder

Returns:

The builder responsible to provide the configuration options for the identity bean.

build

public SecurityConfiguration build()

Builds a SecurityConfiguration instance.

Specified by:

build in interface SecurityConfigurationChildBuilder

Returns:

The consolidated configuration.

create

protected SecurityConfiguration create()
                                throws SecurityConfigurationException

Description copied from class: Builder

Creates a new configuration.

Specified by:

create in class Builder<SecurityConfiguration>

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.

Specified by:

validate in class Builder<SecurityConfiguration>

Throws:

SecurityConfigurationException - if any error occurs or for any invalid configuration

readFrom

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

Description copied from class: Builder

Reads a pre-created configuration.

Specified by:

readFrom in class Builder<SecurityConfiguration>

Returns:

Throws:

SecurityConfigurationException - if any error occurs or for any invalid configuration