/*
 * 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-2008], 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.agent.server;

import org.jboss.remoting.InvokerLocator;



/**
 * Implementors manage the new agent transport lifecycle.
 */
public interface AgentTransportLifecycle extends AgentNotificationHandler {

    /**
     * Start the agent transport.
     */
    void startAgentTransport() throws Exception;

    /**
     * Stop the agent transport.
     */
    void stopAgentTransport();

    /**
     * Update the agent transport after the agent setup.
     * 
     * @see org.hyperic.hq.agent.server.AgentNotificationHandler#handleNotification(java.lang.String, java.lang.String)
     */
    void handleNotification(String msgClass, String msg);
    
    /**
     * Register a service to be hosted by the agent transport.
     * 
     * @param serviceInterface The service interface class.
     * @param serviceImpl The service implementation.
     * @throws IllegalArgumentException if the service does not implement the 
     *                                  interface.
     */
    void registerService(Class serviceInterface, Object serviceImpl);
    
    /**
     * @return The invoker locator to the remote (server-side) transport or 
     *         <code>null</code> if the agent transport has not been started.
     */
    InvokerLocator getRemoteTransportLocator();

}