root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 6 Packages Projects Releases Wiki Activity

Polishing logPrefix Javadoc in ClientRequest|Response 

Closes gh-23791
This commit is contained in:
Rossen Stoyanchev 2019-12-20 09:25:36 +00:00
parent 7456fb9c65
commit a1b8b18282
2 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
spring-webflux/src/main/java/org/springframework/web/reactive/function/client/ClientRequest.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2002-2018 the original author or authors.
* Copyright 2002-2019 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -96,11 +96,10 @@ public interface ClientRequest {
/**
* Return a log message prefix to use to correlate messages for this request.
* The prefix is based on the value of the attribute {@link #LOG_ID_ATTRIBUTE}
* along with some extra formatting so that the prefix can be conveniently
* prepended with no further formatting no separators required.
* The prefix is based on the value of the attribute {@link #LOG_ID_ATTRIBUTE
* LOG_ID_ATTRIBUTE} surrounded with "[" and "]".
* @return the log message prefix or an empty String if the
* {@link #LOG_ID_ATTRIBUTE} is not set.
* {@link #LOG_ID_ATTRIBUTE LOG_ID_ATTRIBUTE} is not set.
* @since 5.1
*/
String logPrefix();

12
spring-webflux/src/main/java/org/springframework/web/reactive/function/client/ClientResponse.java
View File

@ -205,14 +205,12 @@ public interface ClientResponse {
Mono<WebClientResponseException> createException();
/**
* Return a log message prefix to use to correlate messages for this response.
* The prefix is based on the {@linkplain ClientRequest#logPrefix() client
* log prefix}, which itself is based on the value of the request attribute
* {@link ClientRequest#LOG_ID_ATTRIBUTE} along with some extra formatting
* so that the prefix can be conveniently prepended with no further
* formatting no separators required.
* Return a log message prefix to use to correlate messages for this exchange.
* The prefix is based on {@linkplain ClientRequest#logPrefix()}, which
* itself is based on the value of the {@link ClientRequest#LOG_ID_ATTRIBUTE
* LOG_ID_ATTRIBUTE} request attribute, further surrounded with "[" and "]".
* @return the log message prefix or an empty String if the
* {@link ClientRequest#LOG_ID_ATTRIBUTE} was not set.
* {@link ClientRequest#LOG_ID_ATTRIBUTE LOG_ID_ATTRIBUTE} is not set.
* @since 5.2.3
*/
String logPrefix();