org.springframework.social.security.provider

Enum SocialAuthenticationService.ConnectionCardinality

java.lang.Object

java.lang.Enum<SocialAuthenticationService.ConnectionCardinality>

org.springframework.social.security.provider.SocialAuthenticationService.ConnectionCardinality

All Implemented Interfaces:

Serializable, Comparable<SocialAuthenticationService.ConnectionCardinality>

Enclosing interface:

SocialAuthenticationService<S>

public static enum SocialAuthenticationService.ConnectionCardinality
extends Enum<SocialAuthenticationService.ConnectionCardinality>

Enum Constant Summary

Enum Constants

Enum Constant and Description
MANY_TO_MANY no restrictions.
MANY_TO_ONE only one providerUserId per userId, but many userIds per providerUserId.
ONE_TO_MANY many connected providerUserIds per userId, but only one userId per providerUserId
ONE_TO_ONE only one connected providerUserId per userId and vice versa

Method Summary

Modifier and Type	Method and Description
boolean	isAuthenticatePossible()
boolean	isMultiProviderUserId() allow many providerUserIds per userId
boolean	isMultiUserId() allow many userIds per providerUserId.
static SocialAuthenticationService.ConnectionCardinality	valueOf(String name) Returns the enum constant of this type with the specified name.
static SocialAuthenticationService.ConnectionCardinality[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ONE_TO_ONE

public static final SocialAuthenticationService.ConnectionCardinality ONE_TO_ONE

only one connected providerUserId per userId and vice versa

ONE_TO_MANY

public static final SocialAuthenticationService.ConnectionCardinality ONE_TO_MANY

many connected providerUserIds per userId, but only one userId per providerUserId

MANY_TO_ONE

public static final SocialAuthenticationService.ConnectionCardinality MANY_TO_ONE

only one providerUserId per userId, but many userIds per providerUserId. Authentication of users not possible

MANY_TO_MANY

public static final SocialAuthenticationService.ConnectionCardinality MANY_TO_MANY

no restrictions. Authentication of users not possible

Method Detail

values

public static SocialAuthenticationService.ConnectionCardinality[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SocialAuthenticationService.ConnectionCardinality c : SocialAuthenticationService.ConnectionCardinality.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SocialAuthenticationService.ConnectionCardinality valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isMultiUserId

public boolean isMultiUserId()

allow many userIds per providerUserId. If true, authentication is not possible

Returns:

true if multiple local users are allowed per provider user ID

isMultiProviderUserId

public boolean isMultiProviderUserId()

allow many providerUserIds per userId

Returns:

true if users are allowed multiple connections to a provider

isAuthenticatePossible

public boolean isAuthenticatePossible()