From 7e868bb3f1d789100d47284dfe17b43987472b07 Mon Sep 17 00:00:00 2001 From: damencho Date: Tue, 7 Dec 2010 13:44:04 +0000 Subject: [PATCH] Introduce PacketLogger, implementers can log all received or sent packets by the stack. --- src/org/ice4j/stack/Connector.java | 12 +++++++ src/org/ice4j/stack/MessageProcessor.java | 22 ++++++++++-- src/org/ice4j/stack/PacketLogger.java | 41 +++++++++++++++++++++++ src/org/ice4j/stack/StunStack.java | 33 ++++++++++++++++++ 4 files changed, 105 insertions(+), 3 deletions(-) create mode 100644 src/org/ice4j/stack/PacketLogger.java diff --git a/src/org/ice4j/stack/Connector.java b/src/org/ice4j/stack/Connector.java index 941ecde..2cdff90 100644 --- a/src/org/ice4j/stack/Connector.java +++ b/src/org/ice4j/stack/Connector.java @@ -251,6 +251,18 @@ class Connector message, 0, message.length, address); sock.send(datagramPacket); + + // no exception packet is successfully sent, log it + if(StunStack.isPacketLoggerEnabled()) + { + StunStack.getPacketLogger().logPacket( + sock.getLocalAddress().getAddress(), + sock.getLocalPort(), + address.getAddressBytes(), + address.getPort(), + message, + true); + } } /** diff --git a/src/org/ice4j/stack/MessageProcessor.java b/src/org/ice4j/stack/MessageProcessor.java index 555e8bc..2ca9dd8 100644 --- a/src/org/ice4j/stack/MessageProcessor.java +++ b/src/org/ice4j/stack/MessageProcessor.java @@ -152,10 +152,26 @@ class MessageProcessor logger.finest("Dispatching a StunMessageEvent."); - StunMessageEvent stunMessageEvent - = new StunMessageEvent(stunStack, rawMessage, stunMessage); + try + { + StunMessageEvent stunMessageEvent + = new StunMessageEvent(stunStack, rawMessage, stunMessage); - messageEventHandler.handleMessageEvent(stunMessageEvent); + messageEventHandler.handleMessageEvent(stunMessageEvent); + } + finally // make sure we log the packet in case of exception + { + if(StunStack.isPacketLoggerEnabled()) + { + StunStack.getPacketLogger().logPacket( + rawMessage.getRemoteAddress().getAddressBytes(), + rawMessage.getRemoteAddress().getPort(), + rawMessage.getLocalAddress().getAddressBytes(), + rawMessage.getLocalAddress().getPort(), + rawMessage.getBytes(), + false); + } + } } } catch(Throwable err) diff --git a/src/org/ice4j/stack/PacketLogger.java b/src/org/ice4j/stack/PacketLogger.java new file mode 100644 index 0000000..1ed7250 --- /dev/null +++ b/src/org/ice4j/stack/PacketLogger.java @@ -0,0 +1,41 @@ +/* + * ice4j, the OpenSource Java Solution for NAT and Firewall Traversal. + * Maintained by the SIP Communicator community (http://sip-communicator.org). + * + * Distributable under LGPL license. See terms of license at gnu.org. + */ +package org.ice4j.stack; + +/** + * The interface which interested implementers will use in order + * to track and log packets send and received by this stack. + * + * @author Damian Minkov + */ +public interface PacketLogger +{ + /** + * Logs a incoming or outgoing packet. + * + * @param sourceAddress the source address of the packet. + * @param sourcePort the source port. + * @param destinationAddress the destination address of the packet. + * @param destinationPort the destination port. + * @param packetContent the content of the packet. + * @param sender whether we are sending or not the packet. + */ + public void logPacket( + byte[] sourceAddress, + int sourcePort, + byte[] destinationAddress, + int destinationPort, + byte[] packetContent, + boolean sender); + + /** + * Checks whether the logger is enabled. + * @return true if the logger is enabled, false + * otherwise. + */ + public boolean isEnabled(); +} diff --git a/src/org/ice4j/stack/StunStack.java b/src/org/ice4j/stack/StunStack.java index ee6fa30..ee0169c 100644 --- a/src/org/ice4j/stack/StunStack.java +++ b/src/org/ice4j/stack/StunStack.java @@ -83,6 +83,11 @@ public class StunStack */ private final EventDispatcher eventDispatcher = new EventDispatcher(); + /** + * The packet logger instance. + */ + private static PacketLogger packetLogger; + /** * Sets the number of Message processors running in the same time. * @@ -1030,4 +1035,32 @@ public class StunStack return getCredentialsManager().checkLocalUserName(lfrag); } + + /** + * Returns the currently set packet logger. + * @return the currently available packet logger. + */ + static PacketLogger getPacketLogger() + { + return packetLogger; + } + + /** + * Setting a packet logger for the stack. + * @param packetLogger the packet logger to use. + */ + public static void setPacketLogger(PacketLogger packetLogger) + { + StunStack.packetLogger = packetLogger; + } + + /** + * Checks whether packet logger is set and enabled. + * @return true if we have a packet logger instance and + * it is enabled. + */ + static boolean isPacketLoggerEnabled() + { + return packetLogger != null && packetLogger.isEnabled(); + } }