org.seedstack.seed.security.principals

Class Principals

java.lang.Object

org.seedstack.seed.security.principals.Principals

public final class Principals
extends Object

Utility class to create and manipulate common principals.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIRST_NAME
static String	FULL_NAME
static String	IDENTITY
static String	LAST_NAME
static String	LOCALE

Method Summary

Modifier and Type	Method and Description
static SimplePrincipalProvider	firstNamePrincipal(String firstName) Simple principal to store the firstName as a string
static SimplePrincipalProvider	fullNamePrincipal(String fullName) Simple principal to store the fullName as a string
static <T extends Serializable> PrincipalProvider<T>	getOnePrincipalByType(Collection<PrincipalProvider<?>> principalProviders, Class<T> principalClass) Gets one PrincipalProvider corresponding to a type of PrincipalProvider. For example, you can use this method to get the LDAPUser by calling : getOnePrincipalsByType(principals, LDAPUserPrincipalProvider.class) . Then : LDAPUser user = ldapUserPrincipalProvider.getPrincipal().
static <T extends Serializable> Collection<PrincipalProvider<T>>	getPrincipalsByType(Collection<PrincipalProvider<?>> principalProviders, Class<T> principalClass) Gets all the PrincipalProviders corresponding to a type of PrincipalProvider in a collection. For example, you can use this method to get the LDAPUser by calling : getPrincipalsByType(principals, LDAPUserPrincipalProvider.class) . Then on the first element of the collection : LDAPUser user = ldapUserPrincipalProvider.getPrincipal().
static SimplePrincipalProvider	getSimplePrincipalByName(Collection<PrincipalProvider<?>> principalProviders, String principalName) Gives the simple principal with the given name from the given collection of principals
static Collection<SimplePrincipalProvider>	getSimplePrincipals(Collection<PrincipalProvider<?>> principalProviders) Extracts the simple principals of the collection of principals
static SimplePrincipalProvider	identityPrincipal(String identity) Simple principal to store the identity as a string
static SimplePrincipalProvider	lastNamePrincipal(String lastName) Simple principal to store the lastName as a string
static SimplePrincipalProvider	localePrincipal(String locale) Simple principal to store the locale as a string

Methods inherited from class java.lang.Object

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

Field Detail

IDENTITY

public static final String IDENTITY

See Also:

Constant Field Values

LOCALE

public static final String LOCALE

See Also:

Constant Field Values

FIRST_NAME

public static final String FIRST_NAME

See Also:

Constant Field Values

LAST_NAME

public static final String LAST_NAME

See Also:

Constant Field Values

FULL_NAME

public static final String FULL_NAME

See Also:

Constant Field Values

Method Detail

identityPrincipal

public static SimplePrincipalProvider identityPrincipal(String identity)

Simple principal to store the identity as a string

Parameters:

identity - the identity

Returns:

the built principal

localePrincipal

public static SimplePrincipalProvider localePrincipal(String locale)

Simple principal to store the locale as a string

Parameters:

locale - the locale

Returns:

the built principal

firstNamePrincipal

public static SimplePrincipalProvider firstNamePrincipal(String firstName)

Simple principal to store the firstName as a string

Parameters:

firstName - the firstName

Returns:

the built principal

lastNamePrincipal

public static SimplePrincipalProvider lastNamePrincipal(String lastName)

Simple principal to store the lastName as a string

Parameters:

lastName - the lastName

Returns:

the built principal

fullNamePrincipal

public static SimplePrincipalProvider fullNamePrincipal(String fullName)

Simple principal to store the fullName as a string

Parameters:

fullName - the fullName

Returns:

the built principal

getPrincipalsByType

public static <T extends Serializable> Collection<PrincipalProvider<T>> getPrincipalsByType(Collection<PrincipalProvider<?>> principalProviders,
                                                                                            Class<T> principalClass)

Gets all the PrincipalProviders corresponding to a type of PrincipalProvider in a collection.

For example, you can use this method to get the LDAPUser by calling :
getPrincipalsByType(principals, LDAPUserPrincipalProvider.class) .

Then on the first element of the collection :
LDAPUser user = ldapUserPrincipalProvider.getPrincipal().

Type Parameters:

T - type of the PrincipalProvider

Parameters:

principalProviders - the principals to find the type.

principalClass - the PrincipalProvider type, not null

Returns:

A collection of the user's PrincipalProviders of type principalProviderClass. Not null.

getOnePrincipalByType

public static <T extends Serializable> PrincipalProvider<T> getOnePrincipalByType(Collection<PrincipalProvider<?>> principalProviders,
                                                                                  Class<T> principalClass)

Gets one PrincipalProvider corresponding to a type of PrincipalProvider.

For example, you can use this method to get the LDAPUser by calling :
getOnePrincipalsByType(principals, LDAPUserPrincipalProvider.class) .

Then :
LDAPUser user = ldapUserPrincipalProvider.getPrincipal().

Type Parameters:

T - type of the PrincipalProvider

Parameters:

principalProviders - the principals to find the type.

principalClass - the PrincipalProvider type, not null

Returns:

The user's PrincipalProvider of type principalProviderClass. Null if none.

getSimplePrincipals

public static Collection<SimplePrincipalProvider> getSimplePrincipals(Collection<PrincipalProvider<?>> principalProviders)

Extracts the simple principals of the collection of principals

Parameters:

principalProviders - the principals to extract from

Returns:

the simple principals

getSimplePrincipalByName

public static SimplePrincipalProvider getSimplePrincipalByName(Collection<PrincipalProvider<?>> principalProviders,
                                                               String principalName)

Gives the simple principal with the given name from the given collection of principals

Parameters:

principalProviders - the principals to search

principalName - the name to search

Returns:

the simple principal with the name