Package org.ametys.site

Class FrontCurrentUserProvider

java.lang.Object

org.ametys.runtime.plugin.component.AbstractLogEnabled

org.ametys.plugins.core.impl.user.AvalonCurrentUserProvider

org.ametys.site.FrontCurrentUserProvider

All Implemented Interfaces:

CurrentUserProvider, LogEnabled, Contextualizable, ThreadSafe

public class FrontCurrentUserProvider
extends AvalonCurrentUserProvider

CurrentUserProvider able to logout from a site.

Field Summary

Fields inherited from class org.ametys.plugins.core.impl.user.AvalonCurrentUserProvider

_context

Fields inherited from interface org.ametys.core.user.CurrentUserProvider

ROLE

Constructor Summary

Constructors

Constructor	Description
FrontCurrentUserProvider()

Method Summary

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

Methods inherited from class org.ametys.plugins.core.impl.user.AvalonCurrentUserProvider

contextualize

Methods inherited from class org.ametys.runtime.plugin.component.AbstractLogEnabled

getLogger, setLogger

Methods inherited from class java.lang.Object

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

Constructor Details

FrontCurrentUserProvider

public FrontCurrentUserProvider()

Method Details

logout

public void logout(Redirector redirector)
            throws ProcessingException

Description copied from interface: CurrentUserProvider

Logout the current user if he can be.

Specified by:

logout in interface CurrentUserProvider

Overrides:

logout in class AvalonCurrentUserProvider

Parameters:

redirector - the redirector to use if a redirection needs to be perform for the logout. can be null when called during admin operation

Throws:

ProcessingException - If an error occurred during the logout process

getUser

public UserIdentity getUser()

Description copied from interface: CurrentUserProvider

Provides the current logged user.

Specified by:

getUser in interface CurrentUserProvider

Overrides:

getUser in class AvalonCurrentUserProvider

Returns:

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