org.seedstack.seed.security

Interface Realm

public interface Realm

A realm is used to authenticate and retrieve authorization for a user.

Method Summary

Modifier and Type	Method and Description
AuthenticationInfo	getAuthenticationInfo(AuthenticationToken token) Authenticates the user and retrieves its properties in an AuthenticationInfo
Set<String>	getRealmRoles(PrincipalProvider<?> identityPrincipal, Collection<PrincipalProvider<?>> otherPrincipals) Get the roles
RoleMapping	getRoleMapping() Retrieves the RoleMapping associated to this realm
RolePermissionResolver	getRolePermissionResolver() Retrieves the RolePermissionResolver associated to this realm
Class<? extends AuthenticationToken>	supportedToken() Indicates the authentication token supported by this realm

Method Detail

getRealmRoles

Set<String> getRealmRoles(PrincipalProvider<?> identityPrincipal,
                          Collection<PrincipalProvider<?>> otherPrincipals)

Get the roles

Parameters:

identityPrincipal - principal representing the identity of the user

otherPrincipals - other principals

Returns:

the roles of the user. Should not return null but empty collection.

getAuthenticationInfo

AuthenticationInfo getAuthenticationInfo(AuthenticationToken token)
                                  throws AuthenticationException

Authenticates the user and retrieves its properties in an AuthenticationInfo

Parameters:

token - the credentials

Returns:

the authentication of the user

Throws:

AuthenticationException - if the user cannot be authenticated.

getRoleMapping

RoleMapping getRoleMapping()

Retrieves the RoleMapping associated to this realm

Returns:

the RoleMapping

getRolePermissionResolver

RolePermissionResolver getRolePermissionResolver()

Retrieves the RolePermissionResolver associated to this realm

Returns:

the RolePermissionResolver

supportedToken

Class<? extends AuthenticationToken> supportedToken()

Indicates the authentication token supported by this realm

Returns:

the class of AuthenticationToken supported