SnmpInfo (OpenNMS 14.0.0 API)

java.lang.Object
- org.opennms.web.snmpinfo.SnmpInfo

```
public class SnmpInfo
extends Object
```
SnmpInfo class.

Since:

1.8.1

Version:

$Id: $

Author:

ranger

Constructor Summary

Constructors
Constructor and Description

SnmpInfo()
Constructor for SnmpInfo.

SnmpInfo(SnmpAgentConfig config)
Constructor for SnmpInfo.

Constructors
Constructor and Description
`SnmpInfo()` Constructor for SnmpInfo.
`SnmpInfo(SnmpAgentConfig config)` Constructor for SnmpInfo.

Method Summary

Methods
Modifier and Type	Method and Description
`SnmpEventInfo`	`createEventInfo(String ipAddr)` Invokes `createEventInfo(String, String)` with parameters: ipAddr as firstIpAddress and null as lastIpAddress.
`SnmpEventInfo`	`createEventInfo(String firstIpAddress, String lastIpAddress)` Creates a `SnmpEventInfo` object from `this`.
`boolean`	`equals(Object obj)`
`String`	`getAuthPassPhrase()`
`String`	`getAuthProtocol()`
`String`	`getCommunity()` Deprecated. use `getReadCommunity()` instead.
`String`	`getContextEngineId()`
`String`	`getContextName()`
`String`	`getEngineId()`
`String`	`getEnterpriseId()`
`Integer`	`getMaxRepetitions()`
`Integer`	`getMaxRequestSize()`
`Integer`	`getMaxVarsPerPdu()`
`Integer`	`getPort()` getPort
`String`	`getPrivPassPhrase()`
`String`	`getPrivProtocol()`
`String`	`getProxyHost()`
`String`	`getReadCommunity()`
`Integer`	`getRetries()` getRetries
`Integer`	`getSecurityLevel()`
`String`	`getSecurityName()`
`Integer`	`getTimeout()` getTimeout
`String`	`getVersion()` getVersion
`String`	`getWriteCommunity()`
`int`	`hashCode()`
`boolean`	`hasMaxRepetitions()`
`boolean`	`hasMaxRequestSize()`
`boolean`	`hasMaxVarsPerPdu()`
`boolean`	`hasSecurityLevel()` Returns true if `m_securityLevel` is not null.
`boolean`	`hasTimeout()`
`void`	`setAuthPassPhrase(String authPassPhrase)`
`void`	`setAuthProtocol(String authProtocol)`
`void`	`setCommunity(String community)` Deprecated. use `setReadCommunity(String)` instead.
`void`	`setContextEngineId(String contextEngineId)`
`void`	`setContextName(String contextName)`
`void`	`setEngineId(String engineId)`
`void`	`setEnterpriseId(String enterpriseId)`
`void`	`setMaxRepetitions(Integer maxRepetitions)`
`void`	`setMaxRequestSize(Integer maxRequestSize)`
`void`	`setMaxVarsPerPdu(Integer maxVarsPerPdu)`
`void`	`setPort(Integer port)` setPort
`void`	`setPrivPassPhrase(String privPassPhrase)`
`void`	`setPrivProtocol(String privProtocol)`
`void`	`setProxyHost(String proxyHost)`
`void`	`setReadCommunity(String readCommunity)`
`void`	`setRetries(Integer retries)` setRetries
`void`	`setSecurityLevel(Integer securityLevel)`
`void`	`setSecurityName(String securityName)`
`void`	`setTimeout(Integer timeout)` setTimeout
`void`	`setVersion(String version)`
`void`	`setWriteCommunity(String writeCommunity)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- SnmpInfo
```
public SnmpInfo()
```
  Constructor for SnmpInfo.
- SnmpInfo
```
public SnmpInfo(SnmpAgentConfig config)
```
  Constructor for SnmpInfo.
  
  Parameters:
  config - a SnmpAgentConfig object.

Method Detail

getCommunity
```
@Deprecated
public String getCommunity()
```
Deprecated. use getReadCommunity() instead.

getCommunity

Returns:
the read community string

setCommunity
```
@Deprecated
public void setCommunity(String community)
```
Deprecated. use setReadCommunity(String) instead.

setCommunity

Parameters:
community - the read community string to set

getVersion
```
public String getVersion()
```
getVersion

Returns:
the version

setVersion

public void setVersion(String version)

getPort
```
public Integer getPort()
```
getPort

Returns:
the port

setPort
```
public void setPort(Integer port)
```
setPort

Parameters:
port - the port to set

getRetries
```
public Integer getRetries()
```
getRetries

Returns:
the retries

setRetries
```
public void setRetries(Integer retries)
```
setRetries

Parameters:
retries - the retries to set

getTimeout
```
public Integer getTimeout()
```
getTimeout

Returns:
the timeout

setTimeout
```
public void setTimeout(Integer timeout)
```
setTimeout

Parameters:
timeout - the timeout to set

getSecurityName
```
public String getSecurityName()
```

setSecurityName

public void setSecurityName(String securityName)

hasSecurityLevel
```
public boolean hasSecurityLevel()
```
Returns true if m_securityLevel is not null.

Returns:
true if m_securityLevel is not null.

hasTimeout
```
public boolean hasTimeout()
```

hasMaxRequestSize
```
public boolean hasMaxRequestSize()
```

hasMaxRepetitions
```
public boolean hasMaxRepetitions()
```

hasMaxVarsPerPdu
```
public boolean hasMaxVarsPerPdu()
```

getSecurityLevel
```
public Integer getSecurityLevel()
```

setSecurityLevel

public void setSecurityLevel(Integer securityLevel)

getAuthPassPhrase
```
public String getAuthPassPhrase()
```

setAuthPassPhrase

public void setAuthPassPhrase(String authPassPhrase)

getAuthProtocol
```
public String getAuthProtocol()
```

setAuthProtocol

public void setAuthProtocol(String authProtocol)

getPrivPassPhrase
```
public String getPrivPassPhrase()
```

setPrivPassPhrase

public void setPrivPassPhrase(String privPassPhrase)

getPrivProtocol
```
public String getPrivProtocol()
```

setPrivProtocol

public void setPrivProtocol(String privProtocol)

getMaxVarsPerPdu
```
public Integer getMaxVarsPerPdu()
```

setMaxVarsPerPdu

public void setMaxVarsPerPdu(Integer maxVarsPerPdu)

getMaxRepetitions
```
public Integer getMaxRepetitions()
```

setMaxRepetitions

public void setMaxRepetitions(Integer maxRepetitions)

getEngineId
```
public String getEngineId()
```

setEngineId

public void setEngineId(String engineId)

setContextEngineId

public void setContextEngineId(String contextEngineId)

getContextEngineId
```
public String getContextEngineId()
```

setContextName

public void setContextName(String contextName)

getContextName
```
public String getContextName()
```

setEnterpriseId

public void setEnterpriseId(String enterpriseId)

getEnterpriseId
```
public String getEnterpriseId()
```

getReadCommunity
```
public String getReadCommunity()
```

setReadCommunity

public void setReadCommunity(String readCommunity)

getWriteCommunity
```
public String getWriteCommunity()
```

setWriteCommunity

public void setWriteCommunity(String writeCommunity)

getMaxRequestSize
```
public Integer getMaxRequestSize()
```

setMaxRequestSize

public void setMaxRequestSize(Integer maxRequestSize)

getProxyHost
```
public String getProxyHost()
```

setProxyHost

public void setProxyHost(String proxyHost)

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

createEventInfo
```
public SnmpEventInfo createEventInfo(String firstIpAddress,
                            String lastIpAddress)
                              throws UnknownHostException
```
Creates a SnmpEventInfo object from this.

Parameters:
firstIpAddress - a String object which represents the first IP Address of the SnmpEventInfo. Must not be null.
lastIpAddress - represents the last IP Address of the SnmpEventInfo. May be null.

Returns:
a SnmpEventInfo object.

Throws:

UnknownHostException - if any.

createEventInfo
```
public SnmpEventInfo createEventInfo(String ipAddr)
                              throws UnknownHostException
```
Invokes createEventInfo(String, String) with parameters: ipAddr as firstIpAddress and null as lastIpAddress.

Parameters:
ipAddr -

Returns:

Throws:

UnknownHostException
See Also:
createEventInfo(String, String)

Class SnmpInfo

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SnmpInfo

SnmpInfo

Method Detail

getCommunity

setCommunity

getVersion

setVersion

getPort

setPort

getRetries

setRetries

getTimeout

setTimeout

getSecurityName

setSecurityName

hasSecurityLevel

hasTimeout

hasMaxRequestSize

hasMaxRepetitions

hasMaxVarsPerPdu

getSecurityLevel

setSecurityLevel

getAuthPassPhrase

setAuthPassPhrase

getAuthProtocol

setAuthProtocol

getPrivPassPhrase

setPrivPassPhrase

getPrivProtocol

setPrivProtocol

getMaxVarsPerPdu

setMaxVarsPerPdu

getMaxRepetitions

setMaxRepetitions

getEngineId

setEngineId

setContextEngineId

getContextEngineId

setContextName

getContextName

setEnterpriseId

getEnterpriseId

getReadCommunity

setReadCommunity

getWriteCommunity

setWriteCommunity

getMaxRequestSize

setMaxRequestSize

getProxyHost

setProxyHost

equals

hashCode

toString

createEventInfo

createEventInfo