// This Source Code is in the Public Domain per: http://unlicense.org
package org.litesoft.GWT.eventbus.server;

import org.litesoft.GWT.eventbus.client.*;
import org.litesoft.*;

public interface AuthenticatedServerEventBusSupport
{
    public ISystemUser getLoggedInUserFromSEB( ServerEventBus pServerEventBus );

    public AppXtraLoginData getCurrentAppXtraLoginDataFromSEB( ServerEventBus pServerEventBus );

    public void clearLoggedInUserInformationOnSEB( ServerEventBus pServerEventBus );

    public String getLogoutMessageFromSEB( ServerEventBus pServerEventBus );

    public void setLogoutMessageOnSEB( ServerEventBus pServerEventBus, String pLogoutMessage );

    public void clearLogoutMessageOnSEB( ServerEventBus pServerEventBus );

    /**
     * Authenticate (find a SystemUser) based on the pLoginName, pPlainTextPassword.
     *
     * @return found SystemUser
     *
     * @throws AuthenticationException if No SystemUser or SystemUser not allowed to Login, Exception message is the text to the user
     */
    public ISystemUser authenticate( String pLoginName, String pPlainTextPassword )
            throws AuthenticationException;

    public void logoutRequestComplete( ServerEventBus pServerEventBus );
}