SnmpUtils.java

//
// This file is part of the OpenNMS(R) Application.
//
// OpenNMS(R) is Copyright (C) 2005 The OpenNMS Group, Inc.  All rights reserved.
// OpenNMS(R) is a derivative work, containing both original code, included code and modified
// code that was published under the GNU General Public License. Copyrights for modified 
// and included code are below.
//
// OpenNMS(R) is a registered trademark of The OpenNMS Group, Inc.
//
// Original code base Copyright (C) 1999-2001 Oculan Corp.  All rights reserved.
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2 of the License, or
// (at your option) any later version.
//
// 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.
//
// For more information contact:
// OpenNMS Licensing       <license@opennms.org>
//     http://www.opennms.org/
//     http://www.opennms.com/
//
package org.infosec.ismp.snmp;

import java.io.IOException;
import java.net.InetAddress;
import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Properties;

import org.infosec.ismp.util.ThreadCategory;

public class SnmpUtils {

	private static Properties sm_config;

	private static final class TooBigReportingAggregator extends
			AggregateTracker {
		private final InetAddress address;

		private TooBigReportingAggregator(CollectionTracker[] children,
				InetAddress address) {
			super(children);
			this.address = address;
		}

		@Override
		protected void reportTooBigErr(String msg) {
			ThreadCategory.getInstance(SnmpWalker.class).info(
					"Received tooBig response from " + address + ". " + msg);
		}
	}

	public static SnmpWalker createWalker(SnmpAgentConfig agentConfig,
			String name, CollectionTracker... trackers) {
		return getStrategy().createWalker(agentConfig, name,
				createTooBigTracker(agentConfig, trackers));
	}

	private static TooBigReportingAggregator createTooBigTracker(
			SnmpAgentConfig agentConfig, CollectionTracker... trackers) {
		return new TooBigReportingAggregator(trackers, agentConfig.getAddress());
	}

	public static SnmpWalker createWalker(SnmpAgentConfig agentConfig,
			String name, CollectionTracker tracker) {
		return getStrategy().createWalker(agentConfig, name,
				createTooBigTracker(agentConfig, tracker));
	}

	private static TooBigReportingAggregator createTooBigTracker(
			SnmpAgentConfig agentConfig, CollectionTracker tracker) {
		return createTooBigTracker(agentConfig,
				new CollectionTracker[] { tracker });
	}

	public static SnmpValue get(SnmpAgentConfig agentConfig, SnmpObjId oid) {
		return getStrategy().get(agentConfig, oid);
	}

	public static SnmpValue[] get(SnmpAgentConfig agentConfig, SnmpObjId oids[]) {
		return getStrategy().get(agentConfig, oids);
	}

	public static SnmpValue getNext(SnmpAgentConfig agentConfig, SnmpObjId oid) {
		return getStrategy().getNext(agentConfig, oid);
	}

	public static SnmpValue[] getNext(SnmpAgentConfig agentConfig,
			SnmpObjId[] oids) {
		return getStrategy().getNext(agentConfig, oids);
	}

	public static SnmpValue[] getBulk(SnmpAgentConfig agentConfig,
			SnmpObjId[] oids) {
		return getStrategy().getBulk(agentConfig, oids);
	}

	public static SnmpValue set(SnmpAgentConfig agentConfig, SnmpObjId oid,
			SnmpValue value) {
		return getStrategy().set(agentConfig, oid, value);
	}

	public static SnmpValue[] set(SnmpAgentConfig agentConfig,
			SnmpObjId[] oids, SnmpValue[] values) {
		return getStrategy().set(agentConfig, oids, values);
	}

	public static Properties getConfig() {
		return (sm_config == null ? System.getProperties() : sm_config);
	}

	public static List<SnmpValue> getColumns(SnmpAgentConfig agentConfig,
			String name, SnmpObjId oid) throws InterruptedException {

		final List<SnmpValue> results = new ArrayList<SnmpValue>();

		SnmpWalker walker = SnmpUtils.createWalker(agentConfig, name,
				new ColumnTracker(oid) {

					@Override
					protected void storeResult(SnmpResult res) {
						results.add(res.getValue());
					}

				});
		walker.start();
		walker.waitFor();
		return results;
	}

	public static Map<SnmpInstId, SnmpValue> getOidValues(
			SnmpAgentConfig agentConfig, String name, SnmpObjId oid)
			throws InterruptedException {

		final Map<SnmpInstId, SnmpValue> results = new LinkedHashMap<SnmpInstId, SnmpValue>();

		SnmpWalker walker = SnmpUtils.createWalker(agentConfig, name,
				new ColumnTracker(oid) {

					@Override
					protected void storeResult(SnmpResult res) {
						results.put(res.getInstance(), res.getValue());
					}

				});
		walker.start();
		walker.waitFor();
		return results;
	}

	public static void setConfig(Properties config) {
		sm_config = config;
	}

	public static SnmpStrategy getStrategy() {
		String strategyClass = getStrategyClassName();
		try {
			return (SnmpStrategy) Class.forName(strategyClass).newInstance();
		} catch (Exception e) {
			throw new RuntimeException("Unable to instantiate class "
					+ strategyClass, e);
		}
	}

	private static String getStrategyClassName() {
		return getConfig().getProperty("org.infosec.snmp.strategyClass",
				"org.infosec.ismp.snmp.snmp4j.Snmp4JStrategy");
		// return getConfig().getProperty("org.opennms.snmp.strategyClass",
		// "org.opennms.netmgt.snmp.joesnmp.JoeSnmpStrategy");
	}

	public static void registerForTraps(TrapNotificationListener listener,
			TrapProcessorFactory processorFactory, int snmpTrapPort)
			throws IOException {
		getStrategy()
				.registerForTraps(listener, processorFactory, snmpTrapPort);
	}

	public static void unregisterForTraps(TrapNotificationListener listener,
			int snmpTrapPort) throws IOException {
		getStrategy().unregisterForTraps(listener, snmpTrapPort);
	}

	public static SnmpValueFactory getValueFactory() {
		return getStrategy().getValueFactory();
	}

	public static SnmpV1TrapBuilder getV1TrapBuilder() {
		return getStrategy().getV1TrapBuilder();
	}

	public static SnmpTrapBuilder getV2TrapBuilder() {
		return getStrategy().getV2TrapBuilder();
	}

}