Package io.microsphere.spring.web.metadata

Class WebEndpointMapping<E>

  • Type Parameters:
    E - the type of endpoint
    public class WebEndpointMapping<E>
extends java.lang.Object
    The meta-data class for Web Endpoint Mapping that could be one of these endpoints:
    • Servlet
    • Servlet's Filter
    • Spring WebMVC DispatcherServlet
    • Spring WebFlux DispatcherHandler
    • Customized

    The method getKind() can be used to identify the kind of endpoints, and the method getEndpoint() is an abstract presentation of actual endpoint that may be :

    • the name of Servlet
    • the name of Servlet's Filter
    • the any handler of Spring WebMVC org.springframework.web.servlet.HandlerMapping:
      • The String presenting the name of Handler bean
      • The org.springframework.web.servlet.mvc.Controller Bean
      • The HandlerMethod could be annotated the @RequestMapping
      • The org.springframework.web.servlet.function.HandlerFunction since Spring Framework 5.2
    • the any handler of Spring WebFlux org.springframework.web.reactive.HandlerMapping:
      • The String presenting the name of Handler bean
      • The HandlerMethod could be annotated the @RequestMapping
      • The org.springframework.web.reactive.function.server.RouterFunction since Spring Framework 5.0

    The method getSource() can trace the source of WebEndpointMapping if present, it could be :

    • ServletContext
    • Spring WebMVC org.springframework.web.servlet.HandlerMapping
    • Spring WebFlux org.springframework.web.reactive.HandlerMapping
    , or it's non-source
    Since:
    1.0.0
    Author:
    Mercy
    See Also:
    ServletRegistration, FilterRegistration, WebServlet, WebFilter, org.springframework.web.servlet.DispatcherServlet, org.springframework.web.reactive.DispatcherHandler, org.springframework.web.servlet.HandlerMapping, org.springframework.web.reactive.HandlerMapping, RequestMapping, org.springframework.web.servlet.mvc.method.RequestMappingInfo, org.springframework.web.reactive.result.method.RequestMappingInfo

    • Field Detail

      • UNKNOWN_SOURCE

        public static final java.lang.Object UNKNOWN_SOURCE
        The source is unknown

    • Method Detail

      • getKind

        @Nonnull
public WebEndpointMapping.Kind getKind()
        The kind of endpoint:
        • Servlet
        • Servlet's Filter
        • Spring WebMVC DispatcherServlet
        • Spring WebFlux DispatcherHandler
        • Customized
        Returns:
        non-null

      • getEndpoint

        @Nonnull
public E getEndpoint()
        The abstract presentation of actual endpoint that may be :
        • the name of Servlet
        • the name of Servlet's Filter
        • the any handler of Spring WebMVC org.springframework.web.servlet.HandlerMapping:
          • The String presenting the name of Handler bean
          • The org.springframework.web.servlet.mvc.Controller Bean
          • The HandlerMethod could be annotated the @RequestMapping
          • The org.springframework.web.servlet.function.HandlerFunction since Spring Framework 5.2
        • the any handler of Spring WebFlux org.springframework.web.reactive.DispatcherHandler:
          • The String presenting the name of Handler bean
          • The HandlerMethod could be annotated the @RequestMapping
          • The org.springframework.web.reactive.function.server.HandlerFunction since Spring Framework 5.0
        Returns:
        non-null

      • getId

        public int getId()
        The id of endpoint
        Returns:
        id of endpoint

      • isNegated

        public boolean isNegated()
        Get the 'negated' status
        Returns:
        false as default

      • getSource

        @Nonnull
public java.lang.Object getSource()
        The source of WebEndpointMapping if present, it could be :
        • ServletContext
        • Spring WebMVC org.springframework.web.servlet.HandlerMapping
        • Spring WebFlux org.springframework.web.reactive.HandlerMapping
        , or it's non-source
        Returns:
        non-null

      • getPatterns

        @Nonnull
public java.lang.String[] getPatterns()

      • getMethods

        @Nonnull
public java.lang.String[] getMethods()

      • getParams

        @Nonnull
public java.lang.String[] getParams()

      • getHeaders

        @Nonnull
public java.lang.String[] getHeaders()

      • getConsumes

        @Nonnull
public java.lang.String[] getConsumes()

      • getProduces

        @Nonnull
public java.lang.String[] getProduces()

      • setAttribute

        public <V> WebEndpointMapping<E> setAttribute​(java.lang.String name,
                                              @Nullable
                                              V value)

      • getAttribute

        @Nullable
public <V> V getAttribute​(java.lang.String name)

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • toJSON

        public java.lang.String toJSON()