package com.onaro.sanscreen.client.jmxframework;

import com.onaro.sanscreen.client.jmxframework.service.ShutdownService;

/**
 * This interface is the root of the hierarchy for all classes that implement a MBean service.<br>
 * All services implements this interface, for example see {@link ShutdownService}
 * 
 * @since 05/01/2008 
 * @author john.cohen
 */
public interface FrameworkServiceMBean  {
	/**
	 * @return Name of the Service as expose by the MBean Server
	 */
	public String getServiceName();
	
	/**
	 * @return exposes the status of the service if any, for example the subclass will override this 
	 * method to show the status of the service like: "Stopping", "Stopped", an so on.
	 */
	public String getStatus();
	
	/**
	 * This method server as a starting point for classes that carry out the underline service
	 * expose by MBean Server.  Registration with the MBean Server as well as starting the service in question
	 * are done in the subclass that overrides this method.
	 */
	public void start();

	/**
	 * This method represents the end of the life cycle of the service.
	 * Unregister the MBean service as well as cleanup operations are done subclass that overrides this method.
	 */	
	public void stop();
}