ch.qos.logback.classic.sift
Class ContextBasedDiscriminator

java.lang.Object
  extended by ch.qos.logback.core.spi.ContextAwareBase
      extended by ch.qos.logback.classic.sift.ContextBasedDiscriminator
All Implemented Interfaces:
Discriminator<ILoggingEvent>, ContextAware, LifeCycle

public class ContextBasedDiscriminator
extends ContextAwareBase
implements Discriminator<ILoggingEvent>

This discriminator returns the value context to which this event is attached to. If the said value is null, then a default value is returned.

Both Key and the DefaultValue are user specified properties.

Author:
Ceki Gülcü

Field Summary
 
Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase
context
 
Constructor Summary
ContextBasedDiscriminator()
           
 
Method Summary
 String getDefaultValue()
           
 String getDiscriminatingValue(ILoggingEvent event)
          Return the name of the current context name as found in the logging event.
 String getKey()
          The key or variable name under which the discriminating value should be exported into the host environment.
 boolean isStarted()
           
 void setDefaultValue(String defaultValue)
          The default context name in case the context name is not set for the current logging event.
 void setKey(String key)
           
 void start()
           
 void stop()
           
 
Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase
addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ContextBasedDiscriminator

public ContextBasedDiscriminator()
Method Detail

getDiscriminatingValue

public String getDiscriminatingValue(ILoggingEvent event)
Return the name of the current context name as found in the logging event.

Specified by:
getDiscriminatingValue in interface Discriminator<ILoggingEvent>
Returns:

isStarted

public boolean isStarted()
Specified by:
isStarted in interface LifeCycle

start

public void start()
Specified by:
start in interface LifeCycle

stop

public void stop()
Specified by:
stop in interface LifeCycle

getKey

public String getKey()
Description copied from interface: Discriminator
The key or variable name under which the discriminating value should be exported into the host environment.

Specified by:
getKey in interface Discriminator<ILoggingEvent>
Returns:

setKey

public void setKey(String key)

getDefaultValue

public String getDefaultValue()
Returns:
See Also:
setDefaultValue(String)

setDefaultValue

public void setDefaultValue(String defaultValue)
The default context name in case the context name is not set for the current logging event.

Parameters:
defaultValue -


Copyright © 2005-2013 QOS.ch. All Rights Reserved.