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

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

import com.google.gwt.user.client.*;

import java.util.*;

@SuppressWarnings({"UnusedDeclaration"})
public class Documentation_OpenNewWindowProcess {
    // Client(1)/Server Initiated
    public void step1( EventBus pEventBus ) {
        RequestNewClientEventPackage zPackage = new RequestNewClientEventPackage( "Client" );
        // or subclass if new Child needs data from the Parent...
        pEventBus.publish( zPackage );
    }

    // Server Response
    public void step2( EventBus pEventBus, String zNewEncodedClientId ) {
        /**
         * @see AbstractServerApp.RequestNewClientListener eventReceivedVia(...)
         */
        // create a new clientIdNumber for the new window

        // creates a new Temporary ServerEventBus with the new window's clientIdNumber and
        // pInitialEventForNewWindow and all the current ServerEventBus' Broser Data

        pEventBus.publish( new OpenNewClientEventPackage( "Server", zNewEncodedClientId ) );
    }

    // Client(1) Response
    public void step3( String pOurURL, String pWindowNameBase, OpenNewClientEventPackage pEvent ) {
        /**
         * @see AbstractClientEventBusApp.OpenNewClientListener eventReceivedVia(...)
         */
        Window.open( pOurURL, //
                     pWindowNameBase + pEvent.getNewEncodedClientId(), //
                     "" ); // New Window Options
    }

    // Client(2) Initialization
    public void step4() {
        /**
         * @see AbstractClientEventBusApp onModuleLoad
         */
        // String zEncodedClientId = getEncodedClientId(); **** extracted from the Window name!

        // rpc to server - initialize( pEncodedClientId )
        /**
         * @see AbstractServerApp initialize(...)
         */
    }

    // Server Response
    public AppInitializationResult step5( int pClientIdNumber, String pEncodeEncodedClientId,
                                          String zApplicationVersion, AuthenticationData zAuthenticationData ) {
        /**
         * @see AbstractServerApp initialize(...) initializeForBrowserPageRequest(...)
         */
        // get existing ServerEventBus for pClientIdNumber (Temporary ServerEventBus from step2)

        // creates a new 'real' ServerEventBus with the pClientIdNumber and
        // existing ServerEventBus for pClientIdNumber's Broser Data

        // register/subscribe all listeners for server side new client
        ChannelServicePackage eventsResultingFromRegisterSubscribe = null;

        // rpc respond with
        return new AppInitializationResult( pClientIdNumber, //
                                            pEncodeEncodedClientId, //
                                            new HashMap<String, String>(), // Client Config Data
                                            eventsResultingFromRegisterSubscribe, //
                                            zApplicationVersion, //
                                            zAuthenticationData );
    }

    // Client(2) Initialization
    public void step6( AppInitializationResult result ) {
        /**
         * @see AbstractClientEventBusApp.MyAsyncCallback onSuccess
         */

        // Set the Windows Title if debugging
        // UtilsGwt.setWindowTitleWithWindowName( Window.getTitle() );

        // create ClientEventBus (ceb) in suspend mode

        ChannelServicePackage events = result.getChannelServicePackage();

        // propagate events to ClientEventBus

        // register/subscribe:
        //      initialSubscriptions( ceb );
        //      addEventListenersForNewClient( ClientEventBus pClientEventBus )

        // release() the ClientEventBus distribute all the saved up events

        // call finalPrep / appReady with
        //        ClientEventBus,
        result.getAuthenticationData();
    }
}