/**
 * Helios, OpenSource Monitoring
 * Brought to you by the Helios Development Group
 *
 * Copyright 2007, Helios Development Group and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org. 
 *
 */
package org.helios.apmrouter.destination.logstash.senders;

import java.util.HashSet;
import java.util.Set;

import org.helios.apmrouter.server.ServerComponent;
import org.springframework.jmx.export.annotation.ManagedAttribute;

/**
 * <p>Title: AbstractLogstashSender</p>
 * <p>Description: A base class for 'stashers</p> 
 * <p>Company: Helios Development Group LLC</p>
 * @author Whitehead (nwhitehead AT heliosdev DOT org)
 * <p><code>org.helios.apmrouter.destination.logstash.senders.AbstractLogstashSender</code></p>
 * @param <T> The logging event type
 */

public abstract class AbstractLogstashSender<T> extends ServerComponent implements LogstashSender<T> {

	/**
	 * {@inheritDoc}
	 * @see org.helios.apmrouter.destination.logstash.senders.LogstashSender#stash(java.lang.Object)
	 */
	@Override
	public void stash(T stashee) {		
		if(stashee==null) return;
		doStash(stashee);
		incr("AcceptedStashes");
	}
	
	/**
	 * Concrete impl. of stashing one object
	 * @param stashee The object to stash
	 */
	protected abstract void doStash(T stashee);
	
	/**
	 * {@inheritDoc}
	 * @see org.helios.apmrouter.server.ServerComponent#getSupportedMetricNames()
	 */
	@Override
	public Set<String> getSupportedMetricNames() {
		Set<String> _metrics = new HashSet<String>(super.getSupportedMetricNames());
		_metrics.add("AcceptedStashes");
		_metrics.add("FailedStashes");
		_metrics.add("DroppedStashes");
		return _metrics;
	}
	
	/**
	 * Returns the name of the logged type
	 * @return the name of the logged type
	 */
	@ManagedAttribute
	public String getLoggedType() {
		return getAcceptedType().getName();
	}
	


}