Class TransportAuditEvent

java.lang.Object

java.util.EventObject

org.snmp4j.transport.TransportAuditEvent

All Implemented Interfaces:

Serializable

public class TransportAuditEvent
extends EventObject

The TransportAuditEvent describes a transport level operation that is about to be executed (or, for TransportAuditEvent.TransportOperation.CLOSE, has been executed) by a TransportMapping. It is passed to all registered TransportAuditListeners through AbstractTransportMapping.fireTransportAuditEvent(TransportAuditEvent), which lets the listeners control (allow or deny) and audit the transport's communication.

Since:

3.12.0

Version:

3.12.0

Author:

Frank Fock

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TransportAuditEvent.TransportOperation	The TransportOperation enumerates the transport operations that can be audited.

Field Summary

Fields inherited from class EventObject

source

Constructor Summary

Constructors

Constructor	Description
TransportAuditEvent(Object source, TransportAuditEvent.TransportOperation operation, Address peerAddress, Address localAddress, byte[] message)	Creates a TransportAuditEvent.

Method Summary

Modifier and Type	Method	Description
Address	getLocalAddress()	Gets the local (listen) address associated with this event.
byte[]	getMessage()	Gets the message associated with this event.
TransportAuditEvent.TransportOperation	getOperation()	Gets the audited transport operation.
Address	getPeerAddress()	Gets the remote address associated with this event.
String	toString()

Methods inherited from class EventObject

getSource

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

TransportAuditEvent

public TransportAuditEvent(Object source,
 TransportAuditEvent.TransportOperation operation,
 Address peerAddress,
 Address localAddress,
 byte[] message)

Creates a TransportAuditEvent.

Parameters:

source - the TransportMapping that fired this event.

operation - the audited TransportAuditEvent.TransportOperation.

peerAddress - the remote address associated with the operation, or null if the operation does not refer to a remote peer (for example TransportAuditEvent.TransportOperation.LISTEN). For TransportAuditEvent.TransportOperation.SEND this is the target address, for TransportAuditEvent.TransportOperation.RECEIVE the source address of the received message.

localAddress - the local (listen) address associated with the operation, or null if not available.

message - the message associated with the operation for TransportAuditEvent.TransportOperation.SEND and TransportAuditEvent.TransportOperation.RECEIVE, or null otherwise.

Method Details

getOperation

public TransportAuditEvent.TransportOperation getOperation()

Gets the audited transport operation.

Returns:

the TransportAuditEvent.TransportOperation.

getPeerAddress

public Address getPeerAddress()

Gets the remote address associated with this event.

Returns:

the target address for TransportAuditEvent.TransportOperation.SEND, the source address for TransportAuditEvent.TransportOperation.RECEIVE, the closed peer address for a connection TransportAuditEvent.TransportOperation.CLOSE, or null if no remote peer is associated with the operation.

getLocalAddress

public Address getLocalAddress()

Gets the local (listen) address associated with this event.

Returns:

the local address or null if not available.

getMessage

public byte[] getMessage()

Gets the message associated with this event.

Returns:

the message bytes for TransportAuditEvent.TransportOperation.SEND and TransportAuditEvent.TransportOperation.RECEIVE, or null for TransportAuditEvent.TransportOperation.LISTEN and TransportAuditEvent.TransportOperation.CLOSE.

toString

public String toString()

Overrides:

toString in class EventObject