MibTransformBase.java

// Copyright 2014-2015 Boundary, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.boundary.sdk.snmp.metric;

import java.io.IOException;

import org.snmp4j.smi.OID;
import org.snmp4j.smi.SMIConstants;

import com.boundary.plugin.sdk.PluginUtil;
import com.fasterxml.jackson.core.JsonGenerationException;
import com.fasterxml.jackson.databind.JsonMappingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.snmp4j.smi.SmiModule;
import com.snmp4j.smi.SmiObject;
import com.snmp4j.smi.SmiType;

public abstract class MibTransformBase implements MibTransform {

	private static final int SHORT_DISPLAY_NAME_MAX_INDEX = 19;

	protected String getSmiSyntax(int syntax) {
		String s = null;
		
		switch(syntax) {
		case SMIConstants.EXCEPTION_NO_SUCH_INSTANCE:
			s = "EXCEPTION_NO_SUCH_INSTANCE";
			break;
		case SMIConstants.EXCEPTION_END_OF_MIB_VIEW:
			s = "EXCEPTION_END_OF_MIB_VIEW";
			break;
			
		case SMIConstants.EXCEPTION_NO_SUCH_OBJECT:
			s = "EXCEPTION_NO_SUCH_OBJECT";
			break;
//		case SMIConstants.SYNTAX_BITS:
//			s = "SYNTAX_BITS";
//			break;
		case SMIConstants.SYNTAX_COUNTER32:
			s = "SYNTAX_COUNTER32";
			break;
		case SMIConstants.SYNTAX_COUNTER64:
			s = "SYNTAX_COUNTER64";
			break;
		case SMIConstants.SYNTAX_GAUGE32:
			s = "SYNTAX_GAUGE32";
			break;
		case SMIConstants.SYNTAX_INTEGER32:
			s = "SYNTAX_INTEGER32";
			break;
		case SMIConstants.SYNTAX_IPADDRESS:
			s = "SYNTAX_IPADDRESS";
			break;
		case SMIConstants.SYNTAX_NULL:
			s = "SYNTAX_NULL";
			break;
		case SMIConstants.SYNTAX_OBJECT_IDENTIFIER:
			s = "SYNTAX_OBJECT_IDENTIFIER";
			break;
		case SMIConstants.SYNTAX_OCTET_STRING:
			s = "SYNTAX_OCTET_STRING";
			break;
		case SMIConstants.SYNTAX_OPAQUE:
			s = "SYNTAX_OPAQUE";
			break;
		case SMIConstants.SYNTAX_TIMETICKS:
			s = "";
			break;
//		case SMIConstants.SYNTAX_UNSIGNED_INTEGER32:
//			s = "";
//			break;
		}
		
		return s;
	}
	
	public String oidToMetricId(String moduleName,String objectName) {
		String metricId = String.format("SNMP.%s.%s",
				moduleName.replace('-','_'),
				PluginUtil.toUpperUnderscore(objectName,'.'));
		return metricId;
	}
	
	public String oidToDescription(String description) {
		return description.replace('\n',' ').replace("  "," ");
	}
	
	public String oidToDisplayName(String moduleName,String objectName) {
		return String.format("%s::%s",moduleName,objectName);
	}
	
	public String oidToShortDisplayName(String moduleName,String objectName) {
		String shortDisplayName = String.format("%s",objectName);
		int endIndex = Math.min(SHORT_DISPLAY_NAME_MAX_INDEX,shortDisplayName.length()-1);
		shortDisplayName.substring(0,endIndex);
		return shortDisplayName;
	}

	public String oidToGetOid(OID oid) {
		return String.format("%s.0",oid.toDottedString());
	}
	
	public boolean standardFilterCriteria(SmiModule module,SmiObject object) {
		boolean output = false;
		
		if (object.getType() == SmiType.OBJECT_TYPE_SCALAR &&
			(object.getSmiSyntax() == SMIConstants.SYNTAX_COUNTER32 ||
			 object.getSmiSyntax() == SMIConstants.SYNTAX_COUNTER64 ||
			 object.getSmiSyntax() == SMIConstants.SYNTAX_GAUGE32 ||
			 object.getSmiSyntax() == SMIConstants.SYNTAX_INTEGER32)) {
			output = true;
		}
		return output;
	}
	
	public void convertToJson(Object obj) {
		ObjectMapper mapper = new ObjectMapper();
		try {
			mapper.writeValue(System.out,obj);
		} catch (JsonGenerationException e) {
			e.printStackTrace();
		} catch (JsonMappingException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		}
	}

}