Commit a46e047c authored by Johnny Lim's avatar Johnny Lim Committed by Stephane Nicoll

Polish

Closes gh-11792
parent aa36288c
...@@ -28,7 +28,7 @@ public interface ParameterValueMapper { ...@@ -28,7 +28,7 @@ public interface ParameterValueMapper {
/** /**
* A {@link ParameterValueMapper} that does nothing. * A {@link ParameterValueMapper} that does nothing.
*/ */
ParameterValueMapper NONE = (paramere, value) -> value; ParameterValueMapper NONE = (parameter, value) -> value;
/** /**
* Map the specified {@code input} parameter to the given {@code parameterType}. * Map the specified {@code input} parameter to the given {@code parameterType}.
......
...@@ -33,7 +33,7 @@ import org.springframework.web.bind.annotation.GetMapping; ...@@ -33,7 +33,7 @@ import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.PostMapping;
/** /**
* Identifies a type as being a rest endpoint that is only exposed over Spring MVC or * Identifies a type as being an endpoint that is only exposed over Spring MVC or
* Spring WebFlux. Mapped methods must be annotated with {@link GetMapping @GetMapping}, * Spring WebFlux. Mapped methods must be annotated with {@link GetMapping @GetMapping},
* {@link PostMapping @PostMapping}, {@link DeleteMapping @DeleteMapping}, etc annotations * {@link PostMapping @PostMapping}, {@link DeleteMapping @DeleteMapping}, etc annotations
* rather than {@link ReadOperation @ReadOperation}, * rather than {@link ReadOperation @ReadOperation},
...@@ -46,7 +46,7 @@ import org.springframework.web.bind.annotation.PostMapping; ...@@ -46,7 +46,7 @@ import org.springframework.web.bind.annotation.PostMapping;
* @author Phillip Webb * @author Phillip Webb
* @since 2.0.0 * @since 2.0.0
* @see WebEndpoint * @see WebEndpoint
* @see ControllerEndpoint * @see RestControllerEndpoint
*/ */
@Target(ElementType.TYPE) @Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME) @Retention(RetentionPolicy.RUNTIME)
......
...@@ -20,7 +20,6 @@ import java.util.Collection; ...@@ -20,7 +20,6 @@ import java.util.Collection;
import java.util.Collections; import java.util.Collections;
import org.springframework.boot.actuate.endpoint.EndpointFilter; import org.springframework.boot.actuate.endpoint.EndpointFilter;
import org.springframework.boot.actuate.endpoint.ExposableEndpoint;
import org.springframework.boot.actuate.endpoint.Operation; import org.springframework.boot.actuate.endpoint.Operation;
import org.springframework.boot.actuate.endpoint.annotation.DiscoveredOperationMethod; import org.springframework.boot.actuate.endpoint.annotation.DiscoveredOperationMethod;
import org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer; import org.springframework.boot.actuate.endpoint.annotation.EndpointDiscoverer;
...@@ -32,7 +31,7 @@ import org.springframework.core.annotation.AnnotatedElementUtils; ...@@ -32,7 +31,7 @@ import org.springframework.core.annotation.AnnotatedElementUtils;
import org.springframework.util.Assert; import org.springframework.util.Assert;
/** /**
* {@link EndpointDiscoverer} for {@link ExposableEndpoint controller endpoints}. * {@link EndpointDiscoverer} for {@link ExposableControllerEndpoint controller endpoints}.
* *
* @author Phillip Webb * @author Phillip Webb
* @since 2.0.0 * @since 2.0.0
......
...@@ -24,7 +24,7 @@ import org.springframework.web.bind.annotation.RequestMapping; ...@@ -24,7 +24,7 @@ import org.springframework.web.bind.annotation.RequestMapping;
/** /**
* Information describing an endpoint that can be exposed over Spring MVC or Spring * Information describing an endpoint that can be exposed over Spring MVC or Spring
* WebFlux. Mappings should be discovered directly from {@link #getController()} and * WebFlux. Mappings should be discovered directly from {@link #getController()} and
* {@link #getOperations() operation} should always return an empty collection. * {@link #getOperations()} should always return an empty collection.
* *
* @author Phillip Webb * @author Phillip Webb
* @since 2.0.0 * @since 2.0.0
......
...@@ -34,7 +34,7 @@ import org.springframework.web.bind.annotation.PostMapping; ...@@ -34,7 +34,7 @@ import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.ResponseBody; import org.springframework.web.bind.annotation.ResponseBody;
/** /**
* Identifies a type as being an rest endpoint that is only exposed over Spring MVC or * Identifies a type as being a REST endpoint that is only exposed over Spring MVC or
* Spring WebFlux. Mapped methods must be annotated with {@link GetMapping @GetMapping}, * Spring WebFlux. Mapped methods must be annotated with {@link GetMapping @GetMapping},
* {@link PostMapping @PostMapping}, {@link DeleteMapping @DeleteMapping}, etc annotations * {@link PostMapping @PostMapping}, {@link DeleteMapping @DeleteMapping}, etc annotations
* rather than {@link ReadOperation @ReadOperation}, * rather than {@link ReadOperation @ReadOperation},
......
...@@ -55,7 +55,7 @@ public class ControllerEndpointHandlerMapping extends RequestMappingHandlerMappi ...@@ -55,7 +55,7 @@ public class ControllerEndpointHandlerMapping extends RequestMappingHandlerMappi
* Create a new {@link ControllerEndpointHandlerMapping} instance providing mappings * Create a new {@link ControllerEndpointHandlerMapping} instance providing mappings
* for the specified endpoints. * for the specified endpoints.
* @param endpointMapping the base mapping for all endpoints * @param endpointMapping the base mapping for all endpoints
* @param endpoints the web endpoints operations * @param endpoints the web endpoints
* @param corsConfiguration the CORS configuration for the endpoints or {@code null} * @param corsConfiguration the CORS configuration for the endpoints or {@code null}
*/ */
public ControllerEndpointHandlerMapping(EndpointMapping endpointMapping, public ControllerEndpointHandlerMapping(EndpointMapping endpointMapping,
...@@ -72,7 +72,7 @@ public class ControllerEndpointHandlerMapping extends RequestMappingHandlerMappi ...@@ -72,7 +72,7 @@ public class ControllerEndpointHandlerMapping extends RequestMappingHandlerMappi
private Map<Object, ExposableControllerEndpoint> getHandlers( private Map<Object, ExposableControllerEndpoint> getHandlers(
Collection<ExposableControllerEndpoint> endpoints) { Collection<ExposableControllerEndpoint> endpoints) {
Map<Object, ExposableControllerEndpoint> handlers = new LinkedHashMap<>(); Map<Object, ExposableControllerEndpoint> handlers = new LinkedHashMap<>();
endpoints.stream() endpoints
.forEach((endpoint) -> handlers.put(endpoint.getController(), endpoint)); .forEach((endpoint) -> handlers.put(endpoint.getController(), endpoint));
return Collections.unmodifiableMap(handlers); return Collections.unmodifiableMap(handlers);
} }
......
...@@ -83,7 +83,7 @@ public abstract class AbstractWebMvcEndpointHandlerMapping ...@@ -83,7 +83,7 @@ public abstract class AbstractWebMvcEndpointHandlerMapping
* Creates a new {@code WebEndpointHandlerMapping} that provides mappings for the * Creates a new {@code WebEndpointHandlerMapping} that provides mappings for the
* operations of the given {@code webEndpoints}. * operations of the given {@code webEndpoints}.
* @param endpointMapping the base mapping for all endpoints * @param endpointMapping the base mapping for all endpoints
* @param endpoints the web endpoints operations * @param endpoints the web endpoints
* @param endpointMediaTypes media types consumed and produced by the endpoints * @param endpointMediaTypes media types consumed and produced by the endpoints
*/ */
public AbstractWebMvcEndpointHandlerMapping(EndpointMapping endpointMapping, public AbstractWebMvcEndpointHandlerMapping(EndpointMapping endpointMapping,
......
...@@ -55,7 +55,7 @@ public class ControllerEndpointHandlerMapping extends RequestMappingHandlerMappi ...@@ -55,7 +55,7 @@ public class ControllerEndpointHandlerMapping extends RequestMappingHandlerMappi
* Create a new {@link ControllerEndpointHandlerMapping} instance providing mappings * Create a new {@link ControllerEndpointHandlerMapping} instance providing mappings
* for the specified endpoints. * for the specified endpoints.
* @param endpointMapping the base mapping for all endpoints * @param endpointMapping the base mapping for all endpoints
* @param endpoints the web endpoints operations * @param endpoints the web endpoints
* @param corsConfiguration the CORS configuration for the endpoints or {@code null} * @param corsConfiguration the CORS configuration for the endpoints or {@code null}
*/ */
public ControllerEndpointHandlerMapping(EndpointMapping endpointMapping, public ControllerEndpointHandlerMapping(EndpointMapping endpointMapping,
...@@ -73,7 +73,7 @@ public class ControllerEndpointHandlerMapping extends RequestMappingHandlerMappi ...@@ -73,7 +73,7 @@ public class ControllerEndpointHandlerMapping extends RequestMappingHandlerMappi
private Map<Object, ExposableControllerEndpoint> getHandlers( private Map<Object, ExposableControllerEndpoint> getHandlers(
Collection<ExposableControllerEndpoint> endpoints) { Collection<ExposableControllerEndpoint> endpoints) {
Map<Object, ExposableControllerEndpoint> handlers = new LinkedHashMap<>(); Map<Object, ExposableControllerEndpoint> handlers = new LinkedHashMap<>();
endpoints.stream() endpoints
.forEach((endpoint) -> handlers.put(endpoint.getController(), endpoint)); .forEach((endpoint) -> handlers.put(endpoint.getController(), endpoint));
return Collections.unmodifiableMap(handlers); return Collections.unmodifiableMap(handlers);
} }
......
...@@ -62,7 +62,7 @@ public class HttpExchangeTracer { ...@@ -62,7 +62,7 @@ public class HttpExchangeTracer {
* Ends the tracing of the exchange that is being concluded by sending the given * Ends the tracing of the exchange that is being concluded by sending the given
* {@code response}. * {@code response}.
* @param trace the trace for the exchange * @param trace the trace for the exchange
* @param response the response the concludes the exchange * @param response the response that concludes the exchange
* @param principal a supplier for the exchange's principal * @param principal a supplier for the exchange's principal
* @param sessionId a supplier for the id of the exchange's session * @param sessionId a supplier for the id of the exchange's session
*/ */
......
...@@ -112,7 +112,7 @@ public class ServletEndpointDiscovererTests { ...@@ -112,7 +112,7 @@ public class ServletEndpointDiscovererTests {
} }
@Test @Test
public void getEndpointWhenEndpoinSuppliesNullShouldThrowException() { public void getEndpointWhenEndpointSuppliesNullShouldThrowException() {
load(TestServletEndpointSupplierOfNull.class, (discoverer) -> { load(TestServletEndpointSupplierOfNull.class, (discoverer) -> {
this.thrown.expect(IllegalStateException.class); this.thrown.expect(IllegalStateException.class);
this.thrown.expectMessage("must not supply null"); this.thrown.expectMessage("must not supply null");
......
...@@ -142,7 +142,7 @@ public class HttpExchangeTracerTests { ...@@ -142,7 +142,7 @@ public class HttpExchangeTracerTests {
public void mixedCaseCookieHeaderIsNotIncludedByDefault() { public void mixedCaseCookieHeaderIsNotIncludedByDefault() {
HttpTrace trace = new HttpExchangeTracer(EnumSet.of(Include.REQUEST_HEADERS)) HttpTrace trace = new HttpExchangeTracer(EnumSet.of(Include.REQUEST_HEADERS))
.receivedRequest(createRequest(Collections.singletonMap( .receivedRequest(createRequest(Collections.singletonMap(
mixedCase(HttpHeaders.COOKIE), Arrays.asList("valuet")))); mixedCase(HttpHeaders.COOKIE), Arrays.asList("value"))));
Request request = trace.getRequest(); Request request = trace.getRequest();
assertThat(request.getHeaders()).isEmpty(); assertThat(request.getHeaders()).isEmpty();
} }
...@@ -285,7 +285,7 @@ public class HttpExchangeTracerTests { ...@@ -285,7 +285,7 @@ public class HttpExchangeTracerTests {
} }
@Test @Test
public void timeTakedCanBeIncluded() { public void timeTakenCanBeIncluded() {
HttpTrace trace = new HttpTrace(createRequest()); HttpTrace trace = new HttpTrace(createRequest());
new HttpExchangeTracer(EnumSet.of(Include.TIME_TAKEN)).sendingResponse(trace, new HttpExchangeTracer(EnumSet.of(Include.TIME_TAKEN)).sendingResponse(trace,
createResponse(), null, null); createResponse(), null, null);
......
...@@ -151,7 +151,7 @@ use the following additional endpoints: ...@@ -151,7 +151,7 @@ use the following additional endpoints:
|Yes |Yes
|`jolokia` |`jolokia`
|Exposes JMX beans over HTTP (when Jolokia is on the classpath, not availble for WebFlux). |Exposes JMX beans over HTTP (when Jolokia is on the classpath, not available for WebFlux).
|Yes |Yes
|`logfile` |`logfile`
...@@ -1023,7 +1023,7 @@ The Jolokia endpoint can then be exposed by adding `jolokia` or `*` to the ...@@ -1023,7 +1023,7 @@ The Jolokia endpoint can then be exposed by adding `jolokia` or `*` to the
==== Customizing Jolokia ==== Customizing Jolokia
Jolokia has a number of settings that you would traditionally configure by setting servlet Jolokia has a number of settings that you would traditionally configure by setting servlet
parameters. With Spring Boot, you can use your `application.properties` file. To do so, parameters. With Spring Boot, you can use your `application.properties` file. To do so,
prefix the parameter with `management.endpont.jolokia.config.`, as shown in the following prefix the parameter with `management.endpoint.jolokia.config.`, as shown in the following
example: example:
[source,properties,indent=0] [source,properties,indent=0]
......
...@@ -142,7 +142,7 @@ class BootArchiveSupport { ...@@ -142,7 +142,7 @@ class BootArchiveSupport {
Map<RelativePath, FileCopyDetailsInternal> detailsByPath = new TreeMap<>(); Map<RelativePath, FileCopyDetailsInternal> detailsByPath = new TreeMap<>();
stream.process((details) -> detailsByPath.put(details.getRelativePath(), stream.process((details) -> detailsByPath.put(details.getRelativePath(),
details)); details));
detailsByPath.values().stream().forEach(action::processFile); detailsByPath.values().forEach(action::processFile);
}); });
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment