Package org.springframework.security.config.annotation.web.configurers.openid

Class OpenIDLoginConfigurer.AttributeExchangeConfigurer.AttributeConfigurer

java.lang.Object

org.springframework.security.config.annotation.web.configurers.openid.OpenIDLoginConfigurer.AttributeExchangeConfigurer.AttributeConfigurer

Enclosing class:

OpenIDLoginConfigurer.AttributeExchangeConfigurer

public final class OpenIDLoginConfigurer.AttributeExchangeConfigurer.AttributeConfigurer
extends Object

Configures an OpenIDAttribute

Since:

3.2

Method Summary

Modifier and Type	Method	Description
OpenIDLoginConfigurer<H>.AttributeExchangeConfigurer	and()	Gets the OpenIDLoginConfigurer<H extends HttpSecurityBuilder<H>>.AttributeExchangeConfigurer for further customization of the attributes
OpenIDLoginConfigurer<H>.AttributeExchangeConfigurer.AttributeConfigurer	count(int count)	Specifies the number of attribute values to request.
OpenIDLoginConfigurer<H>.AttributeExchangeConfigurer.AttributeConfigurer	name(String name)	The OpenID attribute name.
OpenIDLoginConfigurer<H>.AttributeExchangeConfigurer.AttributeConfigurer	required(boolean required)	Specifies that this attribute is required.
OpenIDLoginConfigurer<H>.AttributeExchangeConfigurer.AttributeConfigurer	type(String type)	The OpenID attribute type.

Methods inherited from class java.lang.Object

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

Method Details

count

public OpenIDLoginConfigurer<H>.AttributeExchangeConfigurer.AttributeConfigurer count(int count)

Specifies the number of attribute values to request. Default is 1.

Parameters:

count - the number of attributes to request.

Returns:

the OpenIDLoginConfigurer<H extends HttpSecurityBuilder<H>>.AttributeExchangeConfigurer.AttributeConfigurer for further customization

required

public OpenIDLoginConfigurer<H>.AttributeExchangeConfigurer.AttributeConfigurer required(boolean required)

Specifies that this attribute is required. The default is false. Note that as outlined in the OpenID specification, required attributes are not validated by the OpenID Provider. Developers should perform any validation in custom code.

Parameters:

required - specifies the attribute is required

Returns:

the OpenIDLoginConfigurer<H extends HttpSecurityBuilder<H>>.AttributeExchangeConfigurer.AttributeConfigurer for further customization

type

public OpenIDLoginConfigurer<H>.AttributeExchangeConfigurer.AttributeConfigurer type(String type)

The OpenID attribute type.

Parameters:

type -

Returns:

the OpenIDLoginConfigurer<H extends HttpSecurityBuilder<H>>.AttributeExchangeConfigurer.AttributeConfigurer for further customizations

name

public OpenIDLoginConfigurer<H>.AttributeExchangeConfigurer.AttributeConfigurer name(String name)

The OpenID attribute name.

Parameters:

name -

Returns:

the OpenIDLoginConfigurer<H extends HttpSecurityBuilder<H>>.AttributeExchangeConfigurer.AttributeConfigurer for further customizations

and

public OpenIDLoginConfigurer<H>.AttributeExchangeConfigurer and()

Gets the OpenIDLoginConfigurer<H extends HttpSecurityBuilder<H>>.AttributeExchangeConfigurer for further customization of the attributes

Returns:

the OpenIDLoginConfigurer<H extends HttpSecurityBuilder<H>>.AttributeExchangeConfigurer.AttributeConfigurer