The category (logger) name.

This field should not be accessed directly. You shoud use the #getLevel method instead.

 public LoggingEvent(String fqnOfCategoryClass,
    Category logger,
    Priority level,
    Object message,
    Throwable throwable) 
{
    this.fqnOfCategoryClass = fqnOfCategoryClass;
    this.logger = logger;
    this.categoryName = logger.getName();
    this.level = level;
    this.message = message;
    if(throwable != null) {
      this.throwableInfo = new ThrowableInformation(throwable, logger);
    }
    timeStamp = System.currentTimeMillis();
}

Instantiate a LoggingEvent from the supplied parameters.

Except #timeStamp all the other fields of LoggingEvent are filled when actually needed.

Parameters:

logger - The logger generating this event.

level - The level of this event.

message - The message of this event.

throwable - The throwable of this event.

 public LoggingEvent(String fqnOfCategoryClass,
    Category logger,
    long timeStamp,
    Priority level,
    Object message,
    Throwable throwable) 
{
    this.fqnOfCategoryClass = fqnOfCategoryClass;
    this.logger = logger;
    this.categoryName = logger.getName();
    this.level = level;
    this.message = message;
    if(throwable != null) {
      this.throwableInfo = new ThrowableInformation(throwable, logger);
    }
    this.timeStamp = timeStamp;
}

Instantiate a LoggingEvent from the supplied parameters.

Except #timeStamp all the other fields of LoggingEvent are filled when actually needed.

Parameters:

logger - The logger generating this event.

timeStamp - the timestamp of this logging event

level - The level of this event.

message - The message of this event.

throwable - The throwable of this event.

 public LoggingEvent(String fqnOfCategoryClass,
    Category logger,
    long timeStamp,
    Level level,
    Object message,
    String threadName,
    ThrowableInformation throwable,
    String ndc,
    LocationInfo info,
    Map properties) 
{
      super();
      this.fqnOfCategoryClass = fqnOfCategoryClass;
      this.logger = logger;
      if (logger != null) {
          categoryName = logger.getName();
      } else {
          categoryName = null;
      }
      this.level = level;
      this.message = message;
      if(throwable != null) {
        this.throwableInfo = throwable;
      }
      this.timeStamp = timeStamp;
      this.threadName = threadName;
      ndcLookupRequired = false;
      this.ndc = ndc;
      this.locationInfo = info;
      mdcCopyLookupRequired = false;
      if (properties != null) {
        mdcCopy = new java.util.Hashtable(properties);
      }
}

Create new instance.

Parameters:

fqnOfCategoryClass - Fully qualified class name of Logger implementation.

logger - The logger generating this event.

timeStamp - the timestamp of this logging event

level - The level of this event.

message - The message of this event.

threadName - thread name

throwable - The throwable of this event.

ndc - Nested diagnostic context

info - Location info

properties - MDC properties

since: 1.2.15 -

 public String getFQNOfLoggerClass() 
{
      return fqnOfCategoryClass;
}

Get the fully qualified name of the calling logger sub-class/wrapper. Provided for compatibility with log4j 1.3

 public Level getLevel() 
{
    return (Level) level;
}

Return the level of this event. Use this form instead of directly accessing the level field.

 public LocationInfo getLocationInformation() 
{
    if(locationInfo == null) {
      locationInfo = new LocationInfo(new Throwable(), fqnOfCategoryClass);
    }
    return locationInfo;
}

Set the location information for this logging event. The collected information is cached for future use.

 public Category getLogger() 
{
      return logger;
}

Gets the logger of the event. Use should be restricted to cloning events.

 public String getLoggerName() 
{
    return categoryName;
}

Return the name of the logger. Use this form instead of directly accessing the categoryName field.

 public Object getMDC(String key) 
{
    Object r;
    // Note the mdcCopy is used if it exists. Otherwise we use the MDC
    // that is associated with the thread.
    if(mdcCopy != null) {
      r = mdcCopy.get(key);
      if(r != null) {
        return r;
      }
    }
    return MDC.get(key);
}

Returns the the context corresponding to the key parameter. If there is a local MDC copy, possibly because we are in a logging server or running inside AsyncAppender, then we search for the key in MDC copy, if a value is found it is returned. Otherwise, if the search in MDC copy returns a null result, then the current thread's MDC is used.

Note that both the local MDC copy and the current thread's MDC are searched.

 public  void getMDCCopy() 
{
    if(mdcCopyLookupRequired) {
      mdcCopyLookupRequired = false;
      // the clone call is required for asynchronous logging.
      // See also bug #5932.
      Hashtable t = (Hashtable) MDC.getContext();
      if(t != null) {
	mdcCopy = (Hashtable) t.clone();
      }
    }
}

Obtain a copy of this thread's MDC prior to serialization or asynchronous logging.

 public Object getMessage() 
{
    if(message != null) {
      return message;
    } else {
      return getRenderedMessage();
    }
}

Return the message for this logging event.

Before serialization, the returned object is the message passed by the user to generate the logging event. After serialization, the returned value equals the String form of the message possibly after object rendering.

 public String getNDC() 
{
    if(ndcLookupRequired) {
      ndcLookupRequired = false;
      ndc = NDC.get();
    }
    return ndc;
}

This method returns the NDC for this event. It will return the correct content even if the event was generated in a different thread or even on a different machine. The NDC#get method should never be called directly.

 public Map getProperties() 
{
      getMDCCopy();
      Map properties;
      if (mdcCopy == null) {
         properties = new HashMap();
      } else {
         properties = mdcCopy;
      }
      return Collections.unmodifiableMap(properties);
}

Returns the set of properties for the event. The returned set is unmodifiable by the caller. Provided for compatibility with log4j 1.3

 public final String getProperty(String key) 
{
        Object value = getMDC(key);
        String retval = null;
        if (value != null) {
            retval = value.toString();
        }
        return retval;
}

Return a property for this event. The return value can be null. Equivalent to getMDC(String) in log4j 1.2. Provided for compatibility with log4j 1.3.

 public Set getPropertyKeySet() 
{
      return getProperties().keySet();
}

Returns the set of the key values in the properties for the event. The returned set is unmodifiable by the caller. Provided for compatibility with log4j 1.3

 public String getRenderedMessage() 
{
     if(renderedMessage == null && message != null) {
       if(message instanceof String)
	 renderedMessage = (String) message;
       else {
	 LoggerRepository repository = logger.getLoggerRepository();
	 if(repository instanceof RendererSupport) {
	   RendererSupport rs = (RendererSupport) repository;
	   renderedMessage= rs.getRendererMap().findAndRender(message);
	 } else {
	   renderedMessage = message.toString();
	 }
       }
     }
     return renderedMessage;
}

 public static long getStartTime() 
{
    return startTime;
}

Returns the time when the application started, in milliseconds elapsed since 01.01.1970.

 public String getThreadName() 
{
    if(threadName == null)
      threadName = (Thread.currentThread()).getName();
    return threadName;
}

 public ThrowableInformation getThrowableInformation() 
{
    return throwableInfo;
}

Returns the throwable information contained within this event. May be null if there is no such information.

Note that the Throwable object contained within a ThrowableInformation does not survive serialization.

 public String[] getThrowableStrRep() 
{
    if(throwableInfo ==  null)
      return null;
    else
      return throwableInfo.getThrowableStrRep();
}

Return this event's throwable's string[] representaion.

 public final long getTimeStamp() 
{
      return timeStamp;
}

Getter for the event's time stamp. The time stamp is calculated starting from 1970-01-01 GMT.

 public final boolean locationInformationExists() 
{
      return (locationInfo != null);
}

Check for the existence of location information without creating it (a byproduct of calling getLocationInformation).

 public Object removeProperty(String propName) 
{
        if (mdcCopy == null) {
            getMDCCopy();
        }
        if (mdcCopy == null) {
            mdcCopy = new Hashtable();
        }
        return mdcCopy.remove(propName);
}

This removes the specified MDC property from the event. Access to the MDC is not synchronized, so this method should only be called when it is known that no other threads are accessing the MDC.

 public final  void setProperty(String propName,
    String propValue) 
{
        if (mdcCopy == null) {
            getMDCCopy();
        }
        if (mdcCopy == null) {
            mdcCopy = new Hashtable();
        }
        mdcCopy.put(propName, propValue);
}

Set value for MDC property. This adds the specified MDC property to the event. Access to the MDC is not synchronized, so this method should only be called when it is known that no other threads are accessing the MDC.