Package org.aoju.bus.tracer.config

Class PropertiesBasedTraceFilter

java.lang.Object

org.aoju.bus.tracer.config.PropertiesBasedTraceFilter

All Implemented Interfaces:

TraceFilterConfig

public final class PropertiesBasedTraceFilter
extends Object
implements TraceFilterConfig

A TraceFilterConfiguration that is based on a PropertyChain. The default property chain may be obtained by the loadPropertyChain() method.

Since:

Java 17+

Author:

Kimi Liu

Nested Class Summary

Nested classes/interfaces inherited from interface org.aoju.bus.tracer.config.TraceFilterConfig

TraceFilterConfig.Channel

Constructor Summary

Constructors

Constructor	Description
PropertiesBasedTraceFilter(PropertyChain propertyChain)
PropertiesBasedTraceFilter(PropertyChain propertyChain, String profileName)

Method Summary

Modifier and Type	Method	Description
Map<String,String>	filterDeniedParams(Map<String,String> unfiltered, TraceFilterConfig.Channel channel)
int	generatedInvocationIdLength()
int	generatedSessionIdLength()
static PropertyChain	loadPropertyChain()	Loads a layered property chain based on: System properties merged entries from all /META-INF/Builder.properties files on the classpath (loaded in undefined order) merged entries from all /META-INF/Builder.default.properties files on the classpath (loaded in undefined order)
boolean	shouldGenerateInvocationId()
boolean	shouldGenerateSessionId()
boolean	shouldProcessContext(TraceFilterConfig.Channel channel)
boolean	shouldProcessParam(String paramName, TraceFilterConfig.Channel channel)

Methods inherited from class java.lang.Object

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

Constructor Details

PropertiesBasedTraceFilter

public PropertiesBasedTraceFilter(PropertyChain propertyChain)

PropertiesBasedTraceFilter

public PropertiesBasedTraceFilter(PropertyChain propertyChain,
 String profileName)

Method Details

loadPropertyChain

public static PropertyChain loadPropertyChain()

Loads a layered property chain based on:

1. System properties
2. merged entries from all /META-INF/Builder.properties files on the classpath (loaded in undefined order)
3. merged entries from all /META-INF/Builder.default.properties files on the classpath (loaded in undefined order)

Returns:

the propertyChain

shouldProcessParam

public boolean shouldProcessParam(String paramName,
 TraceFilterConfig.Channel channel)

Specified by:

shouldProcessParam in interface TraceFilterConfig

shouldProcessContext

public boolean shouldProcessContext(TraceFilterConfig.Channel channel)

Specified by:

shouldProcessContext in interface TraceFilterConfig

shouldGenerateInvocationId

public boolean shouldGenerateInvocationId()

Specified by:

shouldGenerateInvocationId in interface TraceFilterConfig

generatedInvocationIdLength

public int generatedInvocationIdLength()

Specified by:

generatedInvocationIdLength in interface TraceFilterConfig

shouldGenerateSessionId

public boolean shouldGenerateSessionId()

Specified by:

shouldGenerateSessionId in interface TraceFilterConfig

generatedSessionIdLength

public int generatedSessionIdLength()

Specified by:

generatedSessionIdLength in interface TraceFilterConfig

filterDeniedParams

public Map<String,String> filterDeniedParams(Map<String,String> unfiltered,
 TraceFilterConfig.Channel channel)

Specified by:

filterDeniedParams in interface TraceFilterConfig