RC9/qpid/java/management/eclipse-plugin/src/main/java/org/apache/qpid/management/ui/actions/AbstractAction.java

/*
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 */
package org.apache.qpid.management.ui.actions;

import static org.apache.qpid.management.ui.Constants.ERROR_SERVER_CONNECTION;

import java.io.IOException;

import org.apache.qpid.management.ui.ApplicationRegistry;
import org.apache.qpid.management.ui.ApplicationWorkbenchAdvisor;
import org.apache.qpid.management.ui.Constants;
import org.apache.qpid.management.ui.jmx.MBeanUtility;
import org.apache.qpid.management.ui.views.NavigationView;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.dialogs.ErrorDialog;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.ui.IWorkbenchWindow;
import org.eclipse.ui.IWorkbenchWindowActionDelegate;

public class AbstractAction
{
    private NavigationView _navigationView;
    
    protected IWorkbenchWindow _window;
    
    public static final String RMI_SASL_ERROR = "non-JRMP server";
    public static final String SECURITY_FAILURE = "User authentication has failed";   
    public static final String SERVER_UNAVAILABLE = "Qpid server is not running";
    public static final String INVALID_PERSPECTIVE = "Invalid Perspective";
    public static final String CHANGE_PERSPECTIVE = "Please use the Qpid Management Perspective";
      
    /**
     * We will cache window object in order to
     * be able to provide parent shell for the message dialog.
     * @see IWorkbenchWindowActionDelegate#init
     */
    public void init(IWorkbenchWindow window)
    {
        this._window = window;
        if (_window.getShell() != null)
        {
            _window.getShell().setImage(ApplicationRegistry.getImage(Constants.CONSOLE_IMAGE));
        }
    }   

    protected NavigationView getNavigationView()
    {
        if (_navigationView == null)
        {
            _navigationView = (NavigationView)_window.getActivePage().findView(NavigationView.ID);
        }
        
        return _navigationView;
    }
    
    
    protected void handleException(Throwable ex, String title, String msg)
    {
        MBeanUtility.printStackTrace(ex);
        NavigationView view = (NavigationView)_window.getActivePage().findView(NavigationView.ID);
        if (view == null)
        {
            IStatus status = new Status(IStatus.WARNING, ApplicationWorkbenchAdvisor.PERSPECTIVE_ID,
                    IStatus.OK, CHANGE_PERSPECTIVE, null); 
            ErrorDialog.openError(_window.getShell(), "Warning", INVALID_PERSPECTIVE, status);
            return;
        }
        if (msg == null)
        {
            if (ex instanceof IOException)
            {
                if ((ex.getMessage() != null) && (ex.getMessage().indexOf(RMI_SASL_ERROR) != -1))
                {
                    msg = SECURITY_FAILURE;
                }
                else
                {
                    msg = SERVER_UNAVAILABLE;
                }
            }
            else if (ex instanceof SecurityException)
            {
                msg = SECURITY_FAILURE;
            }
            else
            {
                msg = ex.getMessage();
            }
        }
        
        if ((msg == null) && (ex.getCause() != null))
        {
            msg = ex.getCause().getMessage();
        }
        
        if (msg == null)
        {
            msg = ERROR_SERVER_CONNECTION;
        }
        
        if (title == null)
        {
            title = ERROR_SERVER_CONNECTION;
        }
        IStatus status = new Status(IStatus.ERROR, ApplicationWorkbenchAdvisor.PERSPECTIVE_ID,
                                    IStatus.OK, msg, null); 
        ErrorDialog.openError(_window.getShell(), "Error", title, status);
    }
    

    /**
     * Selection in the workbench has been changed. We can change the state of the 'real' action here
     * if we want, but this can only happen after  the delegate has been created.
     * @see IWorkbenchWindowActionDelegate#selectionChanged
     */
    public void selectionChanged(IAction action, ISelection selection) {
    }

    /**
     * We can use this method to dispose of any system resources we previously allocated.
     * @see IWorkbenchWindowActionDelegate#dispose
     */
    public void dispose() {
        
    }
}