com.outbackinc.services.protocol.snmp
Interface SnmpAuthoritativeSession

public interface SnmpAuthoritativeSession

This interface defines the methods that a session implementation must implement. These methods contain state information that can be used in orders sent by one user to one agent. A session refers to one particular host/port, one set of security information, and a particular SNMP version.

A session is used when placing orders, and orders placed using the same session are sent to the same host and port, and are sent using identical security mechanisms and parameters. For example, a session might have a USMSecurityInfo object, which contains a security level of AuthNoPriv, an authentication scheme of MD5, and a particular user-name and auth/priv. passwords. All orders sent using this session will be sent to the same agent/port using MD5 authentication with the user's authentication key, and no encryption.

Multiple sessions, with different or identical security information, can be associated with a single agent/port. SecurityInfo objects may be shared between sessions. For example, a single user may wish to use the same username/passwords, and auth/priv schemes for messages to several different hosts. One SecurityInfo object can be created, and shared among several sessions.

Method Summary

java.net.InetAddress	getAgentAddress() Get the SNMP agent's address used in this session.
java.lang.String	getAgentHostIPAddress() Get the SNMP agent's IP address used in this session.
java.lang.String	getAgentHostName() Get the SNMP agent's host name used in this session.
int	getAgentHostPort() Get the SNMP agent's port used in this session.
java.lang.String	getContextEngineID() Deprecated. as of jSNMP v3.1.1 by getContextEngineIDBytes()
byte[]	getContextEngineIDBytes() Get the context engine ID used in this session.
java.lang.String	getContextName() Deprecated. as of jSNMP v3.1.1 by getContextNameBytes()
byte[]	getContextNameBytes() Get the context name used in this session.
SnmpSecurityInfo	getSnmpSecurityInfo() Get the security information used in this session.
SnmpSecurityToken	getSnmpSecurityToken() Get the security token for this session; the class type of the returned object is SecurityModel dependent, and the session object needs to know nothing about it.
int	getSnmpVersion() Get the SNMP version used in this session.
boolean	isRemote() Determine if session is 'remote' or 'local'.

Method Detail

getAgentHostIPAddress

public java.lang.String getAgentHostIPAddress()

Get the SNMP agent's IP address used in this session.

Returns:

the SNMP agent's IP address.

getAgentHostName

public java.lang.String getAgentHostName()

Get the SNMP agent's host name used in this session.

Returns:

the SNMP agent's host name.

getAgentAddress

public java.net.InetAddress getAgentAddress()

Get the SNMP agent's address used in this session.

Returns:

the SNMP agent's address.

getAgentHostPort

public int getAgentHostPort()

Get the SNMP agent's port used in this session.

Returns:

the SNMP agent's port.

getSnmpVersion

public int getSnmpVersion()

Get the SNMP version used in this session.

Returns:

the SNMP version.

getSnmpSecurityInfo

public SnmpSecurityInfo getSnmpSecurityInfo()

Get the security information used in this session.

Returns:

the security information.

getContextEngineIDBytes

public byte[] getContextEngineIDBytes()

Get the context engine ID used in this session.

Returns:

the context engine ID.

getContextNameBytes

public byte[] getContextNameBytes()

Get the context name used in this session.

Returns:

the context name.

getContextEngineID

public java.lang.String getContextEngineID()

Deprecated. as of jSNMP v3.1.1 by getContextEngineIDBytes()

Get the context engine ID used in this session.

Returns:

the context engine ID.

getContextName

public java.lang.String getContextName()

Deprecated. as of jSNMP v3.1.1 by getContextNameBytes()

Get the context name used in this session.

Returns:

the context name.

getSnmpSecurityToken

public SnmpSecurityToken getSnmpSecurityToken()

Get the security token for this session; the class type of the returned object is SecurityModel dependent, and the session object needs to know nothing about it.

Returns:

security token.

See Also:

SnmpSecurityToken

isRemote

public boolean isRemote()

Determine if session is 'remote' or 'local'.

Returns:

true if remote