/*
 * NOTE: This copyright does *not* cover user programs that use HQ
 * program services by normal system calls through the application
 * program interfaces provided as part of the Hyperic Plug-in Development
 * Kit or the Hyperic Client Development Kit - this is merely considered
 * normal use of the program, and does *not* fall under the heading of
 * "derived work".
 * 
 * Copyright (C) [2004, 2005, 2006], Hyperic, Inc.
 * This file is part of HQ.
 * 
 * HQ is free software; you can redistribute it and/or modify
 * it under the terms version 2 of the GNU General Public License as
 * published by the Free Software Foundation. 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 General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
 * USA.
 */
package org.hyperic.hq.hqu;

import java.io.File;
import java.util.Properties;

import org.hyperic.hq.authz.server.session.AuthzSubject;
import org.hyperic.hq.authz.server.session.Resource;
import org.hyperic.hq.hqu.server.session.Attachment;
import org.hyperic.hq.hqu.server.session.UIPlugin;

/**
 * This interface is implemented by the Groovy HQU dispatcher 
 * (dispatcher.groovy) and acts as a recipient of messages sent from HQ.
 * 
 * Many of these methods correlate to things going on in {@link IHQUPlugin}
 */
public interface IDispatcher {
    /**
     * Called when HQ wants to load a plugin
     */
    Properties loadPlugin(File pluginDir);
    
    /**
     * Called when a plugin is to be deployedn
     */
    void deploy(UIPlugin p);
    
    void handleRequest(Object request);
    
    Object invokeMethod(InvokeMethodInvocationBindings invokeArgs);
    
    AttachmentDescriptor getAttachmentDescriptor(Attachment a, Resource r,
                                                 AuthzSubject u);
}