Package org.ametys.core.user

Interface CurrentUserProvider

All Known Implementing Classes:

AvalonCurrentUserProvider, FrontCurrentUserProvider, WebCurrentUserProvider

public interface CurrentUserProvider

Component which:

• provides the identity of the current user.
• can logout the the current user.

Field Summary

Fields

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

Method Summary

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

Field Details

ROLE

static final String ROLE

Avalon role.

Method Details

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