package org.litesoft.GWT.eventbus.server;

import org.litesoft.GWT.eventbus.client.nonpublic.*;
import org.litesoft.*;
import org.litesoft.orsup.base.*;

public interface IAuthenticationService
{
    public static final String AUTHENTICATION_ERROR_MESSAGE = "Invalid credentials";

    /**
     * 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;

    /**
     * @param pSystemUser !null
     */
    public ClientWindowInstanceDataManager createNewClientWindowInstanceData( ISystemUser pSystemUser );

    /**
     * No modification to the pDataManager is allowed unless there is going to be NO PROBLEMS!
     * @param pDataManager !null
     * @param pSystemUser !null
     */
    public void adjustExistingClientWindowInstanceDataForNewUser(
            ClientWindowInstanceDataManager pDataManager, ISystemUser pSystemUser );

    public static class Null implements IAuthenticationService
    {
        public static final IAuthenticationService INSTANCE = new Null();

        public ISystemUser authenticate( String pLoginName, String pPlainTextPassword )
                throws AuthenticationException
        {
            throw new AuthenticationException( "Null AuthenticationService" );
        }

        public ClientWindowInstanceDataManager createNewClientWindowInstanceData( ISystemUser pSystemUser )
        {
            return null;
        }

        public void adjustExistingClientWindowInstanceDataForNewUser(
                ClientWindowInstanceDataManager pDataManager, ISystemUser pSystemUser )
        {
        }
    }
}