org.pentaho.mantle.client.commands.AbstractCommand.java Source code

Java tutorial

Introduction

Here is the source code for org.pentaho.mantle.client.commands.AbstractCommand.java

Source

/*!
 * This program is free software; you can redistribute it and/or modify it under the
 * terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
 * Foundation.
 *
 * You should have received a copy of the GNU Lesser General Public License along with this
 * program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
 * or from the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU Lesser General Public License for more details.
 *
 * Copyright (c) 2002-2013 Pentaho Corporation..  All rights reserved.
 */

package org.pentaho.mantle.client.commands;

import com.google.gwt.core.client.GWT;
import com.google.gwt.http.client.Request;
import com.google.gwt.http.client.RequestBuilder;
import com.google.gwt.http.client.RequestCallback;
import com.google.gwt.http.client.RequestException;
import com.google.gwt.http.client.Response;
import com.google.gwt.user.client.Command;
import com.google.gwt.user.client.Timer;
import com.google.gwt.user.client.Window;
import com.google.gwt.user.client.rpc.AsyncCallback;

import org.pentaho.gwt.widgets.client.dialogs.IDialogCallback;
import org.pentaho.gwt.widgets.client.dialogs.MessageDialogBox;
import org.pentaho.mantle.client.dialogs.scheduling.ScheduleHelper;
import org.pentaho.mantle.client.messages.Messages;
import org.pentaho.mantle.login.client.MantleLoginDialog;

/**
 * This abstract class needs to be extend when using any command that requires server authentication. The execute
 * method first check whether the user is authenticated or not and then if the user is authentication is performs
 * the command described in the performOperation method, otherwise the login screen will be displayed back to the
 * user
 * 
 * @author rmansoor
 * 
 */
public abstract class AbstractCommand implements Command {

    private CommandCallback commandCallback;

    /**
     * Checks if the user is logged in, if the user is then it perform operation other wise user if ask to perform
     * the login operation again
     * 
     * @param feedback
     *          if the feedback needs to be sent back to the caller. Not used currently
     */
    public void execute(final boolean feedback) {
        try {
            final String url = ScheduleHelper.getFullyQualifiedURL() + "api/mantle/isAuthenticated"; //$NON-NLS-1$
            RequestBuilder requestBuilder = new RequestBuilder(RequestBuilder.GET, url);
            requestBuilder.setHeader("If-Modified-Since", "01 Jan 1970 00:00:00 GMT");
            requestBuilder.setHeader("accept", "text/plain");
            requestBuilder.sendRequest(null, new RequestCallback() {

                public void onError(Request request, Throwable caught) {
                    doLogin(feedback);
                }

                public void onResponseReceived(Request request, Response response) {
                    performOperation(feedback);
                }

            });
        } catch (RequestException e) {
            Window.alert(e.getMessage());
        }
    }

    /**
     * Checks if the user is logged in, if the user is then it perform operation other wise user if ask to perform
     * the login operation again.
     * <p>
     * After the operation is executed, the CommandCallback object receives an afterExecute() notification.
     * 
     * @param commandCallback
     *          CommandCallback object to receive execution notification.
     */
    public void execute(CommandCallback commandCallback) {
        execute(commandCallback, false);
    }

    /**
     * Checks if the user is logged in, if the user is then it perform operation other wise user if ask to perform
     * the login operation again.
     * <p>
     * After the operation is executed, the CommandCallback object receives an afterExecute() notification.
     * 
     * @param commandCallback
     *          CommandCallback object to receive execution notification.
     * @param feedback
     *          if the feedback needs to be sent back to the caller. Not used currently
     */
    public void execute(final CommandCallback commandCallback, final boolean feedback) {
        this.commandCallback = commandCallback;

        try {
            final String url = ScheduleHelper.getFullyQualifiedURL() + "api/mantle/isAuthenticated"; //$NON-NLS-1$
            RequestBuilder requestBuilder = new RequestBuilder(RequestBuilder.GET, url);
            requestBuilder.setHeader("If-Modified-Since", "01 Jan 1970 00:00:00 GMT");
            requestBuilder.setHeader("accept", "text/plain");
            requestBuilder.sendRequest(null, new RequestCallback() {

                public void onError(Request request, Throwable caught) {
                    doLogin(feedback);
                }

                public void onResponseReceived(Request request, Response response) {
                    performOperation(feedback);
                    commandCallback.afterExecute();
                }

            });
        } catch (RequestException e) {
            Window.alert(e.getMessage());
        }

    }

    /**
     * Checks if the user is logged in, if the user is then it perform operation other wise user if ask to perform
     * the login operation again
     */
    public void execute() {
        try {
            final String url = ScheduleHelper.getFullyQualifiedURL() + "api/mantle/isAuthenticated"; //$NON-NLS-1$
            RequestBuilder requestBuilder = new RequestBuilder(RequestBuilder.GET, url);
            requestBuilder.setHeader("If-Modified-Since", "01 Jan 1970 00:00:00 GMT");
            requestBuilder.setHeader("accept", "text/plain");
            requestBuilder.sendRequest(null, new RequestCallback() {

                public void onError(Request request, Throwable caught) {
                    doLogin();
                }

                public void onResponseReceived(Request request, Response response) {
                    performOperation();
                }

            });
        } catch (RequestException e) {
            Window.alert(e.getMessage());
        }
    }

    /**
     * Display the login screen and and validate the credentials supplied by the user if the credentials are correct,
     * the execute method is being invoked other wise error dialog is being display. On clicking ok button on the
     * dialog box, login screen is displayed again and process is repeated until the user click cancel or user is
     * successfully authenticated
     * 
     * @param feedback
     *          if the feedback needs to be sent back to the caller. Not used currently
     */
    private void doLogin(final boolean feedback) {
        MantleLoginDialog.performLogin(new AsyncCallback<Boolean>() {

            public void onFailure(Throwable caught) {
                MessageDialogBox dialogBox = new MessageDialogBox(Messages.getString("error"),
                        Messages.getString("invalidLogin"), false, false, true) {

                }; //$NON-NLS-1$ //$NON-NLS-2$

                dialogBox.setCallback(new IDialogCallback() {
                    public void cancelPressed() {
                        // do nothing
                    }

                    public void okPressed() {
                        doLogin(feedback);
                    }
                });

                dialogBox.center();
            }

            public void onSuccess(Boolean result) {
                if (commandCallback != null) {
                    execute(commandCallback, feedback);
                } else {
                    execute(feedback);
                }
            }

        });
    }

    /**
     * Display the login screen and and validate the credentials supplied by the user if the credentials are correct,
     * the execute method is being invoked other wise error dialog is being display. On clicking ok button on the
     * dialog box, login screen is displayed again and process is repeated until the user click cancel or user is
     * successfully authenticated
     * */
    private void doLogin() {
        Timer t = new Timer() {

            @Override
            public void run() {

                MantleLoginDialog.performLogin(new AsyncCallback<Boolean>() {

                    public void onFailure(Throwable caught) {
                        MessageDialogBox dialogBox = new MessageDialogBox(Messages.getString("error"), //$NON-NLS-1$
                                Messages.getString("invalidLogin"), false, false, true); //$NON-NLS-1$
                        dialogBox.setCallback(new IDialogCallback() {
                            public void cancelPressed() {
                                // do nothing
                            }

                            public void okPressed() {
                                doLogin();
                            }

                        });
                        dialogBox.center();
                    }

                    public void onSuccess(Boolean result) {
                        if (commandCallback != null) {
                            execute(commandCallback);
                        } else {
                            execute();
                        }
                    }

                });
            }
        };
        t.schedule(1);
    }

    /**
     * This is an abstract method which the extending class with implement with logic of performing specific
     * operation
     * 
     * */
    protected abstract void performOperation();

    /**
     * This is an abstract method which the extending class with implement with logic of performing specific
     * operation
     * 
     * @param feedback
     *          if the feedback needs to be sent back to the caller. Not used currently
     * 
     * */
    protected abstract void performOperation(final boolean feedback);
}