org.springframework.security.openid

Class OpenIDAttribute

java.lang.Object

org.springframework.security.openid.OpenIDAttribute

All Implemented Interfaces:

java.io.Serializable

public class OpenIDAttribute
extends java.lang.Object
implements java.io.Serializable

Represents an OpenID subject identity attribute.

Can be used for configuring the OpenID4JavaConsumer with the attributes which should be requested during a fetch request, or to hold values for an attribute which are returned during the authentication process.

Since:

3.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
OpenIDAttribute(java.lang.String name, java.lang.String type)
OpenIDAttribute(java.lang.String name, java.lang.String type, java.util.List<java.lang.String> values)

Method Summary

Modifier and Type	Method and Description
int	getCount() The requested count for the attribute when it is used as part of an authentication request.
java.lang.String	getName() The attribute name
java.lang.String	getType() The attribute type Identifier (a URI).
java.util.List<java.lang.String>	getValues() The values obtained from an attribute exchange.
boolean	isRequired() The "required" flag for the attribute when used with an authentication request.
void	setCount(int count)
void	setRequired(boolean required)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenIDAttribute

public OpenIDAttribute(java.lang.String name,
                       java.lang.String type)

OpenIDAttribute

public OpenIDAttribute(java.lang.String name,
                       java.lang.String type,
                       java.util.List<java.lang.String> values)

Method Detail

getName

public java.lang.String getName()

The attribute name

getType

public java.lang.String getType()

The attribute type Identifier (a URI).

isRequired

public boolean isRequired()

The "required" flag for the attribute when used with an authentication request. Defaults to "false".

setRequired

public void setRequired(boolean required)

getCount

public int getCount()

The requested count for the attribute when it is used as part of an authentication request. Defaults to 1.

setCount

public void setCount(int count)

getValues

public java.util.List<java.lang.String> getValues()

The values obtained from an attribute exchange.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object