cz.ues.platform.security.authn

Interface UESAuthenticationService

@UESComponent
public interface UESAuthenticationService

This service authenticates the user and associates the authentication context with user session to provide principals and credentials during session life.

Since:

UES6-00

Method Summary

Methods

Modifier and Type	Method and Description
void	authenticate(UESAuthenticationToken aToken)
java.lang.String	getConsumerId() Returns consumer ID (ID of service or tool which invoked authentication, e.g. scripting console, external UES service etc.).
Principal	getPrincipal() Returns principal of authenticated user.
java.util.List<Principal>	getPrincipalChain() Returns chain of all authenticated principals.
boolean	isAuthenticated() Returns authentication state.

Method Detail

authenticate

void authenticate(UESAuthenticationToken aToken)
throws UESAuthenticationServiceRTException

Parameters:

aToken - The authentication token with filled credentials used for user authentication.

Throws:

UESAuthenticationServiceRTException - When user can not be authenticated.

Since:

UES6-00

isAuthenticated

boolean isAuthenticated()

Returns authentication state.

Returns:

True when someone is logged in authentication context. False otherwise.

Since:

UES6-00

getPrincipal

Principal getPrincipal()
throws UESAuthenticationServiceRTException

Returns principal of authenticated user. In case authentication is not processed, exception is thrown (to check if calling of method is safe use UESAccountService#isAuthenticated).

Returns:

Principal of authenticated user

Throws:

UESAuthenticationServiceRTException - In case authentication is not processed

Since:

UES6-06

getPrincipalChain

java.util.List<Principal> getPrincipalChain()
throws UESAuthenticationServiceRTException

Returns chain of all authenticated principals. First value in list always represents initially authenticated user, value of next elements depends on usage of UESAuthenticationService.executeAs(String, UESCallable) (each nested call adds another principal to chain). Typically there should be from one to two elements in list. In case authentication is not processed at all, exception is thrown (to check if calling of method is safe use UESAccountService#isAuthenticated).

Returns:

Authenticated principal chain

Throws:

UESAuthenticationServiceRTException - In case authentication is not processed

Since:

UES6-06

getConsumerId

java.lang.String getConsumerId()
throws UESAuthenticationServiceRTException

Returns consumer ID (ID of service or tool which invoked authentication, e.g. scripting console, external UES service etc.). This information is optional and may not be present on authentication context ("Unknown"value is returned). In case authentication is not processed, exception is thrown (to check if calling of method is safe use UESAccountService#isAuthenticated).

Returns:

Consumer ID

Throws:

UESAuthenticationServiceRTException

Since:

UES6-06