public interface

SnmpMsgTranslator

com.sun.jmx.snmp.mpm.SnmpMsgTranslator

Class Overview

The translator interface is implemented by classes dealing with a specific SNMP protocol version. SnmpMsgTranslator are used in conjonction with SnmpMsgProcessingModel implementations.

This API is a Sun Microsystems internal API and is subject to change without notice.

Summary

Public Methods
abstract byte[] getAccessContext(SnmpMsg msg)
Returns the message accesscontext name.
abstract byte[] getContextEngineId(SnmpMsg msg)
Returns the message context Engine Id.
abstract byte[] getContextName(SnmpMsg msg)
Returns the message context name.
abstract byte[] getEncryptedPdu(SnmpMsg msg)
Returns the message encrypted pdu or null if no encryption.
abstract byte[] getFlatSecurityParameters(SnmpMsg msg)
Returns an encoded representation of security parameters contained in the passed msg.
abstract byte getMsgFlags(SnmpMsg msg)
Returns the message flags.
abstract int getMsgId(SnmpMsg msg)
Returns the request or message Id contained in the passed message.
abstract int getMsgMaxSize(SnmpMsg msg)
Returns the response max message size.
abstract int getMsgSecurityModel(SnmpMsg msg)
Returns the message security model.
abstract byte[] getRawContextName(SnmpMsg msg)
Returns the raw message context name.
abstract int getSecurityLevel(SnmpMsg msg)
Returns the message security level.
abstract SnmpSecurityParameters getSecurityParameters(SnmpMsg msg)
Returns the message security parameters.
abstract void setContextEngineId(SnmpMsg req, byte[] contextEngineId)
Set the context engine Id of the passed message.
abstract void setContextName(SnmpMsg req, byte[] contextName)
Set the context name of the passed message.

Public Methods

public abstract byte[] getAccessContext (SnmpMsg msg)

Returns the message accesscontext name. This access context name is used when dealing with access rights (eg: community for V1/V2 or context name for V3).The message is a generic one that is narrowed in the object implementing this interface.

public abstract byte[] getContextEngineId (SnmpMsg msg)

Returns the message context Engine Id. The message is a generic one that is narrowed in the object implementing this interface.

public abstract byte[] getContextName (SnmpMsg msg)

Returns the message context name. The message is a generic one that is narrowed in the object implementing this interface.

public abstract byte[] getEncryptedPdu (SnmpMsg msg)

Returns the message encrypted pdu or null if no encryption. The message is a generic one that is narrowed in the object implementing this interface.

public abstract byte[] getFlatSecurityParameters (SnmpMsg msg)

Returns an encoded representation of security parameters contained in the passed msg. The message is a generic one that is narrowed in the object implementing this interface.

public abstract byte getMsgFlags (SnmpMsg msg)

Returns the message flags. The message is a generic one that is narrowed in the object implementing this interface.

public abstract int getMsgId (SnmpMsg msg)

Returns the request or message Id contained in the passed message. The message is a generic one that is narrowed in the object implementing this interface.

public abstract int getMsgMaxSize (SnmpMsg msg)

Returns the response max message size. The message is a generic one that is narrowed in the object implementing this interface.

public abstract int getMsgSecurityModel (SnmpMsg msg)

Returns the message security model. The message is a generic one that is narrowed in the object implementing this interface.

public abstract byte[] getRawContextName (SnmpMsg msg)

Returns the raw message context name. Raw mean as it is received from the network, without translation. It can be useful when some data are piggy backed in the context name.The message is a generic one that is narrowed in the object implementing this interface.

public abstract int getSecurityLevel (SnmpMsg msg)

Returns the message security level. The message is a generic one that is narrowed in the object implementing this interface.

public abstract SnmpSecurityParameters getSecurityParameters (SnmpMsg msg)

Returns the message security parameters. The message is a generic one that is narrowed in the object implementing this interface.

public abstract void setContextEngineId (SnmpMsg req, byte[] contextEngineId)

Set the context engine Id of the passed message.

public abstract void setContextName (SnmpMsg req, byte[] contextName)

Set the context name of the passed message.