Package io.microsphere.spring.web.metadata

Class RegistrationWebEndpointMappingFactory<R extends jakarta.servlet.Registration>

java.lang.Object

io.microsphere.spring.web.metadata.AbstractWebEndpointMappingFactory<String>

io.microsphere.spring.web.metadata.RegistrationWebEndpointMappingFactory<R>

Type Parameters:

R - The type of RegistrationWebEndpointMappingFactory

All Implemented Interfaces:

WebEndpointMappingFactory<String>

Direct Known Subclasses:

FilterRegistrationWebEndpointMappingFactory, ServletRegistrationWebEndpointMappingFactory

public abstract class RegistrationWebEndpointMappingFactory<R extends jakarta.servlet.Registration>
extends AbstractWebEndpointMappingFactory<String>

The abstract class of AbstractWebEndpointMappingFactory for Servlet Registration

Since:

1.0.0

Author:

Mercy

See Also:

• AbstractWebEndpointMappingFactory

Field Summary

Fields

Modifier and Type	Field	Description
protected final jakarta.servlet.ServletContext	servletContext

Fields inherited from class io.microsphere.spring.web.metadata.AbstractWebEndpointMappingFactory

logger

Constructor Summary

Constructors

Constructor	Description
RegistrationWebEndpointMappingFactory(jakarta.servlet.ServletContext servletContext)

Method Summary

Modifier and Type	Method	Description
protected void	contribute(String endpoint, jakarta.servlet.ServletContext servletContext, WebEndpointMapping.Builder<String> builder)	Contribute the WebEndpointMapping.Builder to create an instance of WebEndpointMapping
protected final WebEndpointMapping<String>	doCreate(String endpoint)
protected WebEndpointMapping.Kind	getKind(R registration)
protected abstract Collection<String>	getMethods(R registration)	Gets the HTTP methods of the given registration
protected abstract Collection<String>	getPatterns(R registration)	Get the patterns of Registration
protected abstract R	getRegistration(String name, jakarta.servlet.ServletContext servletContext)
final boolean	supports(String endpoint)	Current factory supports the specified endpoint or not

Methods inherited from class io.microsphere.spring.web.metadata.AbstractWebEndpointMappingFactory

create

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.microsphere.spring.web.metadata.WebEndpointMappingFactory

getSourceType

Field Details

servletContext

protected final jakarta.servlet.ServletContext servletContext

Constructor Details

RegistrationWebEndpointMappingFactory

public RegistrationWebEndpointMappingFactory(jakarta.servlet.ServletContext servletContext)

Method Details

supports

public final boolean supports(String endpoint)

Description copied from interface: WebEndpointMappingFactory

Current factory supports the specified endpoint or not

Parameters:

endpoint - could be one of these :

• ServletRegistration
• FilterRegistration
• org.springframework.web.servlet.mvc.method.RequestMappingInfo
• org.springframework.web.reactive.result.method.RequestMappingInfo

Returns:

true if supports, false otherwise

doCreate

protected final WebEndpointMapping<String> doCreate(String endpoint)
                                             throws Throwable

Specified by:

doCreate in class AbstractWebEndpointMappingFactory<String>

Throws:

Throwable

getKind

protected WebEndpointMapping.Kind getKind(R registration)

getMethods

@Nonnull
protected abstract Collection<String> getMethods(R registration)

Gets the HTTP methods of the given registration

Parameters:

registration - the registration

Returns:

the HTTP methods of the given registration

getRegistration

@Nonnull
protected abstract R getRegistration(String name,
 jakarta.servlet.ServletContext servletContext)

Parameters:

name - the name of Registration

servletContext - ServletContext

Returns:

The Registration

getPatterns

@Nonnull
protected abstract Collection<String> getPatterns(R registration)

Get the patterns of Registration

Parameters:

registration - Registration

Returns:

non-null

contribute

protected void contribute(String endpoint,
 jakarta.servlet.ServletContext servletContext,
 WebEndpointMapping.Builder<String> builder)
                   throws Throwable

Contribute the WebEndpointMapping.Builder to create an instance of WebEndpointMapping

Parameters:

endpoint - the name of Registration

servletContext - ServletContext

builder - WebEndpointMapping.Builder

Throws:

Throwable - an error if contribution failed