package org.sadun.util.polling;

/**
 * This interface is used in conjunction with the JMX instrumentation
 * {@link ManagedDirectoryPoller ManagedDirectoryPoller} of {@link 
 * DirectoryPoller DirectoryPoller}.
 * <p>
 * The JMX console user can specify the name of a class implementing
 * this interface, which is in turn used to produce a set of {@link PollManager
 * PollManager} objects which are added to {@link ManagedDirectoryPoller 
 * ManagedDirectoryPoller}.
 * <p>
 * The implementing class must have a public default constructor.
 * 
 * @author cris
 */
public interface PollManagerFactory {
	
	/**
	 * Create the {@link PollManager PollManager} to add to the 
	 * {@link ManagedDirectoryPoller ManagedDirectoryPoller} MBean.
	 * <p>
	 * The MBean JMX <tt>ObjectName</tt> is passed to the factory,
	 * so that it can discriminate among different Mbean instances.
	 * <p>
	 * @param mBeanName the <tt>ObjectName</tt> of the MBean to which the 
	 *         {@link PollManager PollManager}s are going to be added.
	 * @return PollManager[] the PollManager objects to add.
	 */
	public PollManager[] createPollManagers(String mBeanName);
	
	/**
	 * Provides a description of the factory.
	 * @return String
	 */
	public String getDescription();

}