Home | History | Annotate | Download | only in sip
      1 package gov.nist.javax.sip;
      2 
      3 
      4 /**
      5  * The stack calls the message log factory to create logging records. The default implementatation
      6  * of this interface can be replaced using the gov.nist.javax.sip.LOG_RECORD_FACTORY property.
      7  * This override is provided to allow applications to log axuiliary information (such as environment
      8  * conditions etc) when messages are logged in the stack.
      9  *
     10  * @author M. Ranganathan
     11  *
     12  */
     13 public interface LogRecordFactory {
     14 
     15     /**
     16      * Create a log record.
     17      *
     18      * @param message  -- the message to be logged.
     19      * @param source   -- host:port of the source of the message.
     20      * @param destination -- host:port of the destination of the message.
     21      * @param timeStamp  -- The time at which this message was seen by the stack or sent out by
     22      *                      the stack.
     23      * @param isSender   -- true if we are sending the message false otherwise.
     24      * @param firstLine  -- the first line of the message to be logged.
     25      * @param tid -- the transaction id
     26      * @param callId -- the call id
     27      * @param timestampVal -- the timestamp header value of the incoming message.
     28      *
     29      * @return -- a log record with the appropriate fields set.
     30      */
     31 
     32 
     33     public LogRecord createLogRecord(String message, String source,
     34             String destination, long timeStamp, boolean isSender,
     35             String firstLine, String tid, String callId, long timestampVal);
     36 
     37 }
     38