Package io.microsphere.spring.web.metadata

Class WebEndpointMapping<E>

java.lang.Object

io.microsphere.spring.web.metadata.WebEndpointMapping<E>

Type Parameters:

E - the type of endpoint

public class WebEndpointMapping<E>
extends 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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WebEndpointMapping.Builder<E>
static enum	WebEndpointMapping.Kind	WebEndpointMapping Kind

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID_HEADER_NAME	The HTTP header name for getId()
static final Object	UNKNOWN_SOURCE	The source is unknown

Method Summary

Modifier and Type	Method	Description
static <E> WebEndpointMapping.Builder<E>	customized()	Create a WebEndpointMapping.Builder of WebEndpointMapping for customized.
boolean	equals(Object o)
static <E> WebEndpointMapping.Builder<E>	filter()	Create a WebEndpointMapping.Builder of WebEndpointMapping for filter.
<V> V	getAttribute(String name)
String[]	getConsumes()
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
String[]	getHeaders()
int	getId()	The id of endpoint
WebEndpointMapping.Kind	getKind()	The kind of endpoint: Servlet Servlet's Filter Spring WebMVC DispatcherServlet Spring WebFlux DispatcherHandler Customized
String[]	getMethods()
String[]	getParams()
String[]	getPatterns()
String[]	getProduces()
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
int	hashCode()
boolean	isNegated()	Get the 'negated' status
static <E> WebEndpointMapping.Builder<E>	of(WebEndpointMapping.Kind kind)	Create a WebEndpointMapping.Builder of WebEndpointMapping with specified kind.
static <E> WebEndpointMapping.Builder<E>	servlet()	Create a WebEndpointMapping.Builder of WebEndpointMapping for servlet.
<V> WebEndpointMapping<E>	setAttribute(String name, V value)
String	toJSON()
String	toString()
static <E> WebEndpointMapping.Builder<E>	webflux()	Create a WebEndpointMapping.Builder of WebEndpointMapping for webFlux.
static <E> WebEndpointMapping.Builder<E>	webmvc()	Create a WebEndpointMapping.Builder of WebEndpointMapping for webMvc.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

ID_HEADER_NAME

public static final String ID_HEADER_NAME

The HTTP header name for getId()

See Also:

• Constant Field Values

UNKNOWN_SOURCE

public static final Object UNKNOWN_SOURCE

The source is unknown

Method Details

servlet

@Nonnull
public static <E> WebEndpointMapping.Builder<E> servlet()
                                                 throws IllegalArgumentException

Create a WebEndpointMapping.Builder of WebEndpointMapping for servlet.

Type Parameters:

E - the type of endpoint

Returns:

a WebEndpointMapping.Builder of WebEndpointMapping

Throws:

IllegalArgumentException - if the endpoint is null

filter

@Nonnull
public static <E> WebEndpointMapping.Builder<E> filter()
                                                throws IllegalArgumentException

Create a WebEndpointMapping.Builder of WebEndpointMapping for filter.

Type Parameters:

E - the type of endpoint

Returns:

a WebEndpointMapping.Builder of WebEndpointMapping

Throws:

IllegalArgumentException - if the endpoint is null

webmvc

@Nonnull
public static <E> WebEndpointMapping.Builder<E> webmvc()
                                                throws IllegalArgumentException

Create a WebEndpointMapping.Builder of WebEndpointMapping for webMvc.

Type Parameters:

E - the type of endpoint

Returns:

a WebEndpointMapping.Builder of WebEndpointMapping

Throws:

IllegalArgumentException - if the endpoint is null

webflux

@Nonnull
public static <E> WebEndpointMapping.Builder<E> webflux()
                                                 throws IllegalArgumentException

Create a WebEndpointMapping.Builder of WebEndpointMapping for webFlux.

Type Parameters:

E - the type of endpoint

Returns:

a WebEndpointMapping.Builder of WebEndpointMapping

Throws:

IllegalArgumentException - if the endpoint is null

customized

@Nonnull
public static <E> WebEndpointMapping.Builder<E> customized()
                                                    throws IllegalArgumentException

Create a WebEndpointMapping.Builder of WebEndpointMapping for customized.

Type Parameters:

E - the type of endpoint

Returns:

a WebEndpointMapping.Builder of WebEndpointMapping

Throws:

IllegalArgumentException - if the endpoint is null

of

@Nonnull
public static <E> WebEndpointMapping.Builder<E> of(@Nonnull
 WebEndpointMapping.Kind kind)
                                            throws IllegalArgumentException

Create a WebEndpointMapping.Builder of WebEndpointMapping with specified kind.

Type Parameters:

E - the type of endpoint

Parameters:

kind - the kind of endpoint

Returns:

a WebEndpointMapping.Builder of WebEndpointMapping

Throws:

IllegalArgumentException - if the kind or endpoint is null

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 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 String[] getPatterns()

getMethods

@Nonnull
public String[] getMethods()

getParams

@Nonnull
public String[] getParams()

getHeaders

@Nonnull
public String[] getHeaders()

getConsumes

@Nonnull
public String[] getConsumes()

getProduces

@Nonnull
public String[] getProduces()

setAttribute

public <V> WebEndpointMapping<E> setAttribute(String name,
 @Nullable
 V value)

getAttribute

@Nullable
public <V> V getAttribute(String name)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

toJSON

public String toJSON()