com.sap.cloud.sdk.quality

Class AnnotationBasedHttpClientListener

java.lang.Object

com.sap.cloud.sdk.quality.FileWritingHttpClientListener

com.sap.cloud.sdk.quality.AnnotationBasedHttpClientListener

All Implemented Interfaces:

HttpClientListener

public class AnnotationBasedHttpClientListener
extends FileWritingHttpClientListener

HttpClientListener implementation printing the content of the CodeQuality annotation located somewhere on the StackTrace.

This feature is introduced to allow the SDK Pipeline to check for certain code qualities at test runtime.

This is not intended for productive usage, but only for tests!

Note: This listener (as all HttpClientListener implementations) are only automatically called when HTTP calls are done via the HttpClient provided by the HttpClientAccessor.

The resulting report line will look something like this:

     http://0.0.0.0/myEndpoint,"package.to.ResilientClass(RESILIENCE),other.package.to.OtherResilientClass(Some Quality,Another Quality)"
 

So it will have the URI of the called endpoint in the first column and all classes annotated with CodeQuality currently on the StackTrace, together with the values of the annotation.

Constructor Summary

Constructors

Constructor and Description
AnnotationBasedHttpClientListener()
AnnotationBasedHttpClientListener(Path reportPath) Creates a new listener, writing the report into a file at the given path.

Method Summary

Modifier and Type	Method and Description
protected String	getReportValuePerCalledUri() Returns the value that should be printed in the second column of the report file.

Methods inherited from class com.sap.cloud.sdk.quality.FileWritingHttpClientListener

onRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationBasedHttpClientListener

public AnnotationBasedHttpClientListener(@Nullable
                                         Path reportPath)

Creates a new listener, writing the report into a file at the given path.

Parameters:

reportPath - The path the report should be written to.

AnnotationBasedHttpClientListener

public AnnotationBasedHttpClientListener()

Method Detail

getReportValuePerCalledUri

@Nonnull
protected String getReportValuePerCalledUri()

Returns the value that should be printed in the second column of the report file.

The content of this second column is highly sub-class specific, so look there for more details.

Specified by:

getReportValuePerCalledUri in class FileWritingHttpClientListener

Returns:

The actual reported value (if any). Might very well be empty, but never null.