Class AWSXRayServletFilter
- java.lang.Object
-
- com.amazonaws.xray.jakarta.servlet.AWSXRayServletFilter
-
- All Implemented Interfaces:
jakarta.servlet.Filter
public class AWSXRayServletFilter extends java.lang.Object implements jakarta.servlet.Filter
-
-
Constructor Summary
Constructors Constructor Description AWSXRayServletFilter()
Warning: this no-args constructor should not be used directly.AWSXRayServletFilter(@Nullable SegmentNamingStrategy segmentNamingStrategy)
AWSXRayServletFilter(@Nullable SegmentNamingStrategy segmentNamingStrategy, @Nullable AWSXRayRecorder recorder)
AWSXRayServletFilter(java.lang.String fixedSegmentName)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
destroy()
void
doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain)
@Nullable java.lang.String
getSegmentDefaultName()
@Nullable java.lang.String
getSegmentOverrideName()
void
init(jakarta.servlet.FilterConfig config)
void
postFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response)
Segment
preFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response)
void
setSegmentDefaultName(java.lang.String segmentDefaultName)
void
setSegmentOverrideName(java.lang.String segmentOverrideName)
-
-
-
Constructor Detail
-
AWSXRayServletFilter
public AWSXRayServletFilter()
Warning: this no-args constructor should not be used directly. This constructor is made available for use from withinweb.xml
and other declarative file-based instantiations.
-
AWSXRayServletFilter
public AWSXRayServletFilter(java.lang.String fixedSegmentName)
-
AWSXRayServletFilter
public AWSXRayServletFilter(@Nullable SegmentNamingStrategy segmentNamingStrategy)
-
AWSXRayServletFilter
public AWSXRayServletFilter(@Nullable SegmentNamingStrategy segmentNamingStrategy, @Nullable AWSXRayRecorder recorder)
-
-
Method Detail
-
getSegmentOverrideName
public @Nullable java.lang.String getSegmentOverrideName()
- Returns:
- the segmentOverrideName
-
setSegmentOverrideName
public void setSegmentOverrideName(java.lang.String segmentOverrideName)
- Parameters:
segmentOverrideName
- the segmentOverrideName to set
-
getSegmentDefaultName
public @Nullable java.lang.String getSegmentDefaultName()
- Returns:
- the segmentDefaultName
-
setSegmentDefaultName
public void setSegmentDefaultName(java.lang.String segmentDefaultName)
- Parameters:
segmentDefaultName
- the segmentDefaultName to set
-
init
public void init(jakarta.servlet.FilterConfig config) throws jakarta.servlet.ServletException
- Specified by:
init
in interfacejakarta.servlet.Filter
- Parameters:
config
- the filter configuration. There are various init-params which may be passed on initialization. The values in init-params will create segment naming strategies which override those passed in constructors.-
fixedName A String value used as the fixedName parameter for a created
FixedSegmentNamingStrategy
. Used only if thedynamicNamingFallbackName
init-param is not set. -
dynamicNamingFallbackName A String value used as the fallbackName parameter for a created
DynamicSegmentNamingStrategy
. -
dynamicNamingRecognizedHosts A String value used as the recognizedHosts parameter for a created
DynamicSegmentNamingStrategy
.
-
fixedName A String value used as the fixedName parameter for a created
- Throws:
jakarta.servlet.ServletException
- when a segment naming strategy is not provided in constructor arguments nor in init-params.
-
destroy
public void destroy()
- Specified by:
destroy
in interfacejakarta.servlet.Filter
-
doFilter
public void doFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response, jakarta.servlet.FilterChain chain) throws java.io.IOException, jakarta.servlet.ServletException
- Specified by:
doFilter
in interfacejakarta.servlet.Filter
- Throws:
java.io.IOException
jakarta.servlet.ServletException
-
preFilter
public Segment preFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response)
-
postFilter
public void postFilter(jakarta.servlet.ServletRequest request, jakarta.servlet.ServletResponse response)
-
-