org.ametys.core.user

Interface CurrentUserProvider

All Known Implementing Classes:

AvalonCurrentUserProvider, WebCurrentUserProvider

public interface CurrentUserProvider

Component which:

• test if the current logged in user is the super user.
• provides the login of the current user.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ROLE Avalon role.

Method Summary

Modifier and Type	Method and Description
UserIdentity	getUser() Provides the current logged user.
void	logout() Logout the current user if he can be.

Field Detail

ROLE

static final String ROLE

Avalon role.

Method Detail

getUser

UserIdentity getUser()

Provides the current logged user.

Returns:

the current user or null if there is no logged user.

logout

void logout()
     throws ProcessingException

Logout the current user if he can be.

Throws:

ProcessingException - If an error occurred during the logout process