io microsphere spring web servlet function ConsumingWebEndpointMappingAdapter

ConsumingWebEndpointMappingAdapter

Type: Class | Module: microsphere-spring-webmvc | Package: io.microsphere.spring.web.servlet.function | Since: 1.0.0

Source: microsphere-spring-webmvc/src/main/java/io/microsphere/spring/web/servlet/function/ConsumingWebEndpointMappingAdapter.java

Overview

The adapter class of RequestPredicateVisitorAdapter and RouterFunctionVisitorAdapter to consume the WebEndpointMapping WebEndpointMappings generated during the visiting process.

This class is designed to traverse Spring WebMVC router functions and their associated request predicates, collecting metadata about web endpoints. It implements both visitor interfaces to capture information such as HTTP methods, path patterns, headers, and query parameters.

Example Usage

`// Create a consumer to handle the generated WebEndpointMappings
Consumer mappingConsumer = mapping -> {
    System.out.println("Endpoint: " + mapping.getEndpoint());
    System.out.println("Patterns: " + Arrays.toString(mapping.getPatterns()));
    System.out.println("Methods: " + Arrays.toString(mapping.getMethods()));
`;

// Create the adapter
ConsumingWebEndpointMappingAdapter adapter = new ConsumingWebEndpointMappingAdapter(mappingConsumer);

// Visit a router function to collect endpoint mappings
RouterFunction routerFunction = ...; // your router function
routerFunction.accept(adapter);
}

Declaration

public class ConsumingWebEndpointMappingAdapter implements RequestPredicateVisitorAdapter, RouterFunctionVisitorAdapter

Author: Mercy

Version Information

• Introduced in: 1.0.0
• Current Project Version: 0.2.27-SNAPSHOT

Version Compatibility

This component is tested and compatible with the following Java versions:

Java Version	Status
Java 17	✅ Compatible
Java 21	✅ Compatible
Java 25	✅ Compatible

Examples

// Create a consumer to handle the generated WebEndpointMappings
Consumer<WebEndpointMapping> mappingConsumer = mapping -> {
    System.out.println("Endpoint: " + mapping.getEndpoint());
    System.out.println("Patterns: " + Arrays.toString(mapping.getPatterns()));
    System.out.println("Methods: " + Arrays.toString(mapping.getMethods()));
};

// Create the adapter
ConsumingWebEndpointMappingAdapter adapter = new ConsumingWebEndpointMappingAdapter(mappingConsumer);

// Visit a router function to collect endpoint mappings
RouterFunction<?> routerFunction = ...; // your router function
routerFunction.accept(adapter);

Usage

Maven Dependency

Add the following dependency to your pom.xml:

<dependency>
    <groupId>io.github.microsphere-projects</groupId>
    <artifactId>microsphere-spring-webmvc</artifactId>
    <version>${microsphere-spring.version}</version>
</dependency>

Tip: Use the BOM (microsphere-spring-dependencies) for consistent version management. See the Getting Started guide.

Import

import io.microsphere.spring.web.servlet.function.ConsumingWebEndpointMappingAdapter;

API Reference

Public Methods

Method	Description
method
path
header
param
startNested
endNested
route

See Also

• RequestPredicateVisitorAdapter
• RouterFunctionVisitorAdapter
• WebEndpointMapping

---

This documentation was auto-generated from the source code of microsphere-spring.