org.opennms.web.svclayer.model.SnmpInfo Maven / Gradle / Ivy

Go to download
/*
 * Licensed to The OpenNMS Group, Inc (TOG) under one or more
 * contributor license agreements.  See the LICENSE.md file
 * distributed with this work for additional information
 * regarding copyright ownership.
 *
 * TOG licenses this file to You under the GNU Affero General
 * Public License Version 3 (the "License") or (at your option)
 * any later version.  You may not use this file except in
 * compliance with the License.  You may obtain a copy of the
 * License at:
 *
 *      https://www.gnu.org/licenses/agpl-3.0.txt
 *
 * 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 org.opennms.web.svclayer.model;

import java.net.UnknownHostException;

import javax.xml.bind.annotation.XmlRootElement;

import org.apache.commons.lang.builder.EqualsBuilder;
import org.apache.commons.lang.builder.HashCodeBuilder;
import org.apache.commons.lang.builder.ToStringBuilder;
import org.apache.commons.lang.builder.ToStringStyle;
import org.opennms.core.utils.InetAddressUtils;
import org.opennms.netmgt.config.SnmpEventInfo;
import org.opennms.netmgt.snmp.SnmpAgentConfig;

/**
 * 
 * SnmpInfo class.
 * 
 * 
 * @author ranger
 * @version $Id: $
 * @since 1.8.1
 */
@XmlRootElement(name = "snmp-info")
public class SnmpInfo {
	private String m_readCommunity;
	private String m_version;
	private Integer m_port;
	private Integer m_retries;
	private Integer m_timeout;
	private Integer m_maxVarsPerPdu;
	private Integer m_maxRepetitions;
	private String m_securityName;
	private Integer m_securityLevel;
	private String m_authPassPhrase;
	private String m_authProtocol;
	private String m_privPassPhrase;
	private String m_privProtocol;
	private String m_engineId;
	private String m_contextEngineId;
	private String m_contextName;
	private String m_enterpriseId;
	private Integer m_maxRequestSize;
	private String m_writeCommunity;
	private String m_proxyHost;
	private String m_location;
	private Long m_ttl;
	
	/**
	 * 
	 * Constructor for SnmpInfo.
	 * 
	 */
	public SnmpInfo() {

	}

	/**
	 * 
	 * Constructor for SnmpInfo.
	 * 
	 * 
	 * @param config
	 *            a {@link org.opennms.netmgt.snmp.SnmpAgentConfig} object.
	 */
	public SnmpInfo(SnmpAgentConfig config) {
		if (config == null) return;

		m_version = config.getVersionAsString();
		if (config.getPort() >= 1) m_port = config.getPort();
		if (config.getTimeout() >= 1) m_timeout = config.getTimeout();
		if (config.getRetries() >= 1) m_retries = config.getRetries();
		if (config.getMaxRepetitions() >= 1) m_maxRepetitions = config.getMaxRepetitions();
		if (config.getMaxVarsPerPdu() >= 1) m_maxVarsPerPdu = config.getMaxVarsPerPdu();
		if (config.getMaxRequestSize() >= 1) m_maxRequestSize = Integer.valueOf(config.getMaxRequestSize());
		// handle a possible proxy host setting
		if (config.getProxyFor() != null) { // switch proxy and address
			m_proxyHost = InetAddressUtils.str(config.getAddress());
		}
		if (config.getTTL() != null) m_ttl = config.getTTL();
		
		// only set these properties if snmp version is v3
		if (config.isVersion3()) {
			m_securityName = config.getSecurityName();
			m_securityLevel = Integer.valueOf(config.getSecurityLevel());
			m_authPassPhrase = config.getAuthPassPhrase();
			m_authProtocol = config.getAuthProtocol();
			m_privPassPhrase = config.getPrivPassPhrase();
			m_privProtocol = config.getPrivProtocol();
			m_engineId = config.getEngineId();
			m_contextEngineId = config.getContextEngineId();
			m_contextName = config.getContextName();
			m_enterpriseId = config.getEnterpriseId();
		} else { // can only be set if snmp version is not v3
			m_readCommunity = config.getReadCommunity();
			m_writeCommunity = config.getWriteCommunity();
		}
	}

	/**
	 * 
	 * getCommunity
	 * 
	 * 
	 * @return the read community string
	 * @deprecated use {@link #getReadCommunity()} instead.
	 */
	@Deprecated
	public String getCommunity() {
		return getReadCommunity();
	}

	/**
	 * 
	 * setCommunity
	 * 
	 * 
	 * @param community
	 *            the read community string to set
	 * @deprecated use {@link #setReadCommunity(String)} instead.
	 */
	@Deprecated
	public void setCommunity(String community) {
		setReadCommunity(community);
	}

	/**
	 * 
	 * getVersion
	 * 
	 * 
	 * @return the version
	 */
	public String getVersion() {
		return m_version;
	}

	public void setVersion(String version) {
		m_version = version;
	}

	/**
	 * 
	 * getPort
	 * 
	 * 
	 * @return the port
	 */
	public Integer getPort() {
		return m_port;
	}

	/**
	 * 
	 * setPort
	 * 
	 * 
	 * @param port
	 *            the port to set
	 */
	public void setPort(Integer port) {
		m_port = port;
	}

	/**
	 * 
	 * getRetries
	 * 
	 * 
	 * @return the retries
	 */
	public Integer getRetries() {
		return m_retries;
	}

	/**
	 * 
	 * setRetries
	 * 
	 * 
	 * @param retries
	 *            the retries to set
	 */
	public void setRetries(Integer retries) {
		m_retries = retries;
	}

	/**
	 * 
	 * getTimeout
	 * 
	 * 
	 * @return the timeout
	 */
	public Integer getTimeout() {
		return m_timeout;
	}

	/**
	 * 
	 * setTimeout
	 * 
	 * 
	 * @param timeout
	 *            the timeout to set
	 */
	public void setTimeout(Integer timeout) {
		m_timeout = timeout;
	}

	/**
     * @return the m_location
     */
    public String getLocation() {
        return m_location;
    }

    /**
     * @param location the m_location to set
     */
    public void setLocation(String location) {
        this.m_location = location;
    }


    public String getSecurityName() {
		return m_securityName;
	}

	public void setSecurityName(String securityName) {
		m_securityName = securityName;
	}

	/**
	 * Returns true if {@link #m_securityLevel} is not null.
	 * 
	 * @return true if {@link #m_securityLevel} is not null.
	 */
	public boolean hasSecurityLevel() {
		return m_securityLevel != null;
	}

	public boolean hasTimeout() {
		return m_timeout != null;
	}
	
	public boolean hasMaxRequestSize() {
		return m_maxRequestSize != null;
	}
	
	public boolean hasMaxRepetitions() {
		return m_maxRepetitions != null;
	}
	
	public boolean hasMaxVarsPerPdu() {
		return m_maxVarsPerPdu != null;
	}
	
	public Integer getSecurityLevel() {
		return m_securityLevel;
	}

	public void setSecurityLevel(Integer securityLevel) {
		m_securityLevel = securityLevel;
	}

	public String getAuthPassPhrase() {
		return m_authPassPhrase;
	}

	public void setAuthPassPhrase(String authPassPhrase) {
		m_authPassPhrase = authPassPhrase;
	}

	public String getAuthProtocol() {
		return m_authProtocol;
	}

	public void setAuthProtocol(String authProtocol) {
		m_authProtocol = authProtocol;
	}

	public String getPrivPassPhrase() {
		return m_privPassPhrase;
	}

	public void setPrivPassPhrase(String privPassPhrase) {
		m_privPassPhrase = privPassPhrase;
	}

	public String getPrivProtocol() {
		return m_privProtocol;
	}

	public void setPrivProtocol(String privProtocol) {
		m_privProtocol = privProtocol;
	}

	public Integer getMaxVarsPerPdu() {
		return m_maxVarsPerPdu;
	}

	public void setMaxVarsPerPdu(Integer maxVarsPerPdu) {
		m_maxVarsPerPdu = maxVarsPerPdu;
	}

	public Integer getMaxRepetitions() {
		return m_maxRepetitions;
	}

	public void setMaxRepetitions(Integer maxRepetitions) {
		m_maxRepetitions = maxRepetitions;
	}

	public String getEngineId() {
		return m_engineId;
	}

	public void setEngineId(final String engineId) {
		m_engineId = engineId;
	}

	public void setContextEngineId(final String contextEngineId) {
		m_contextEngineId = contextEngineId;
	}

	public String getContextEngineId() {
		return m_contextEngineId;
	}

	public void setContextName(final String contextName) {
		m_contextName = contextName;
	}

	public String getContextName() {
		return m_contextName;
	}

	public void setEnterpriseId(final String enterpriseId) {
		m_enterpriseId = enterpriseId;
	}

	public String getEnterpriseId() {
		return m_enterpriseId;
	}
	
	public String getReadCommunity() {
		return m_readCommunity;
	}
	
	public void setReadCommunity(String readCommunity) {
		m_readCommunity = readCommunity;
	}

	public String getWriteCommunity() {
		return m_writeCommunity;
	}
	
	public void setWriteCommunity(String writeCommunity) {
		m_writeCommunity = writeCommunity;
	}
	
	public Integer getMaxRequestSize() {
		return m_maxRequestSize;
	}
	
	public void setMaxRequestSize(Integer maxRequestSize) {
		m_maxRequestSize = maxRequestSize;
	}
	
	public String getProxyHost() {
		return m_proxyHost;
	}
	
	public void setProxyHost(String proxyHost) {
		m_proxyHost = proxyHost;
	}

	public Long getTTL() {
		return m_ttl;
	}

	public void setTTL(Long ttl) {
		m_ttl = ttl;
	}

	@Override
	public boolean equals(Object obj) {
		return EqualsBuilder.reflectionEquals(this, obj);
	}

	@Override
	public int hashCode() {
		return HashCodeBuilder.reflectionHashCode(this);
	}

	@Override
	public String toString() {
		return ToStringBuilder.reflectionToString(this, ToStringStyle.SHORT_PREFIX_STYLE);
	}
	

	/**
	 * Creates a {@link SnmpEventInfo} object from this.
	 * 
	 * @param firstIpAddress
	 *            a {@link java.lang.String} object which represents the first IP Address of the {@link SnmpEventInfo}. Must not be null.
	 * @param lastIpAddress represents the last IP Address of the {@link SnmpEventInfo}. May be null.
	 * @return a {@link org.opennms.netmgt.config.SnmpEventInfo} object. 
	 * @throws java.net.UnknownHostException if any.
	 */
	public SnmpEventInfo createEventInfo(String firstIpAddress, String lastIpAddress) throws UnknownHostException {
		SnmpEventInfo eventInfo = new SnmpEventInfo();
		eventInfo.setVersion(m_version);
		eventInfo.setAuthPassPhrase(m_authPassPhrase);
		eventInfo.setAuthProtocol(m_authProtocol);
		eventInfo.setReadCommunityString(m_readCommunity);
		eventInfo.setWriteCommunityString(m_writeCommunity);
		eventInfo.setContextEngineId(m_contextEngineId);
		eventInfo.setContextName(m_contextName);
		eventInfo.setEngineId(m_engineId);
		eventInfo.setEnterpriseId(m_enterpriseId);
		eventInfo.setFirstIPAddress(firstIpAddress);
		eventInfo.setLastIPAddress(lastIpAddress);
		eventInfo.setPrivPassPhrase(m_privPassPhrase);
		eventInfo.setPrivProtocol(m_privProtocol);
		eventInfo.setSecurityName(m_securityName);
		eventInfo.setProxyHost(m_proxyHost);
		eventInfo.setLocation(m_location);
		eventInfo.setTTL(getTTL());
		if (m_port != null) eventInfo.setPort(m_port.intValue());
		if (m_retries != null) eventInfo.setRetryCount(m_retries.intValue());
		if (m_timeout != null) eventInfo.setTimeout(m_timeout.intValue());
		if (m_maxRepetitions != null) eventInfo.setMaxRepetitions(m_maxRepetitions.intValue());
		if (m_maxVarsPerPdu != null) eventInfo.setMaxVarsPerPdu(m_maxVarsPerPdu.intValue());
		if (m_maxRequestSize != null) eventInfo.setMaxRequestSize(m_maxRequestSize.intValue());
		if (m_securityLevel != null) eventInfo.setSecurityLevel(m_securityLevel.intValue());
		if (m_maxRequestSize != null) eventInfo.setMaxRequestSize(m_maxRequestSize.intValue());
		return eventInfo;
	}
	
	/**
	 * Invokes {@link #createEventInfo(String, String)} with parameters: ipAddr
	 * as firstIpAddress and null as lastIpAddress.
	 * 
	 * @param ipAddr
	 * @return
	 * @throws UnknownHostException
	 * @see #createEventInfo(String, String)
	 */
	public SnmpEventInfo createEventInfo(String ipAddr) throws UnknownHostException {
		return createEventInfo(ipAddr, null);
	}
}