package org.litesoft.GWT.eventbus.client.eventpackages;

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

/**
 * Fire this event whenever you want to explicitly signout the user from the
 * current session. It will not reset the EventBus but will make the UI switch
 * to the SignIn page. All non saved UI state will be lost. This event should be
 * used on severe errors or high risk authentication failures only.
 */
public class SignOutEventPackage extends AuthenticationEventPackage
{
    public static final String SubscribeWith = "SignOut";

    private String mMessage;

    /**
     * @deprecated GWT ONLY
     */
    public SignOutEventPackage()
    {
    }

    private SignOutEventPackage( String pSourceName, String pMessage )
    {
        super( pSourceName, SubscribeWith, null );
        mMessage = pMessage;
    }

    public static EventPackage build( EventBus pEventBus, String pMessage )
    {
        return new SignOutEventPackage( pEventBus.getForm(), pMessage );
    }

    public String getMessage()
    {
        return mMessage;
    }

    protected void augmentToString( StringBuilder pSB )
    {
        super.augmentToString( pSB );
        add( pSB, mMessage );
    }
}