- /*
- * @(#)file SnmpIncomingResponse.java
- * @(#)author Sun Microsystems, Inc.
- * @(#)version 1.16
- * @(#)date 04/09/15
- *
- * Copyright 2004 Sun Microsystems, Inc. All rights reserved.
- * SUN PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
- *
- */
- package com.sun.jmx.snmp.internal;
-
- import java.net.InetAddress;
- import com.sun.jmx.snmp.SnmpPduFactory;
- import com.sun.jmx.snmp.SnmpSecurityParameters;
- import com.sun.jmx.snmp.SnmpSecurityException;
- import com.sun.jmx.snmp.SnmpTooBigException;
- import com.sun.jmx.snmp.SnmpStatusException;
- import com.sun.jmx.snmp.SnmpPdu;
- import com.sun.jmx.snmp.SnmpMsg;
-
- import com.sun.jmx.snmp.internal.SnmpSecurityCache;
- import com.sun.jmx.snmp.SnmpBadSecurityLevelException;
- /**
- * <P> An <CODE>SnmpIncomingResponse</CODE> handles the unmarshalling of the received response.</P>
- * <p><b>This API is a Sun Microsystems internal API and is subject
- * to change without notice.</b></p>
- * @since 1.5
- */
-
- public interface SnmpIncomingResponse {
- /**
- * Returns the source address.
- * @return The source address.
- */
- public InetAddress getAddress();
-
- /**
- * Returns the source port.
- * @return The source port.
- */
- public int getPort();
-
- /**
- * Gets the incoming response security parameters.
- * @return The security parameters.
- **/
- public SnmpSecurityParameters getSecurityParameters();
- /**
- * Call this method in order to reuse <CODE>SnmpOutgoingRequest</CODE> cache.
- * @param cache The security cache.
- */
- public void setSecurityCache(SnmpSecurityCache cache);
- /**
- * Gets the incoming response security level. This level is defined in
- * {@link com.sun.jmx.snmp.SnmpEngine SnmpEngine}.
- * @return The security level.
- */
- public int getSecurityLevel();
- /**
- * Gets the incoming response security model.
- * @return The security model.
- */
- public int getSecurityModel();
- /**
- * Gets the incoming response context name.
- * @return The context name.
- */
- public byte[] getContextName();
-
- /**
- * Decodes the specified bytes and initializes itself with the received
- * response.
- *
- * @param inputBytes The bytes to be decoded.
- *
- * @exception SnmpStatusException If the specified bytes are not a valid encoding.
- */
- public SnmpMsg decodeMessage(byte[] inputBytes,
- int byteCount,
- InetAddress address,
- int port)
- throws SnmpStatusException, SnmpSecurityException;
-
- /**
- * Gets the request PDU encoded in the received response.
- * <P>
- * This method decodes the data field and returns the resulting PDU.
- *
- * @return The resulting PDU.
- * @exception SnmpStatusException If the encoding is not valid.
- */
- public SnmpPdu decodeSnmpPdu()
- throws SnmpStatusException;
-
- /**
- * Returns the response request Id.
- * @param data The flat message.
- * @return The request Id.
- */
- public int getRequestId(byte[] data) throws SnmpStatusException;
-
- /**
- * Returns a stringified form of the message to send.
- * @return The message state string.
- */
- public String printMessage();
- }