Package dev.hilla

Class EndpointControllerConfiguration

java.lang.Object

dev.hilla.EndpointControllerConfiguration

@Configuration
public class EndpointControllerConfiguration
extends Object

A configuration class for customizing the EndpointController class.

Constructor Summary

Constructors

Constructor	Description
EndpointControllerConfiguration(EndpointProperties endpointProperties)	Initializes the endpoint configuration.

Method Summary

Modifier and Type	Method	Description
com.vaadin.flow.server.auth.AccessAnnotationChecker	accessAnnotationChecker()	Registers a default AccessAnnotationChecker bean instance.
EndpointAccessChecker	accessChecker(com.vaadin.flow.server.auth.AccessAnnotationChecker accessAnnotationChecker)	Registers a default EndpointAccessChecker bean instance.
CsrfChecker	csrfChecker(javax.servlet.ServletContext servletContext)	Registers a default CsrfChecker bean instance.
EndpointInvoker	endpointInvoker(org.springframework.context.ApplicationContext applicationContext, com.fasterxml.jackson.databind.ObjectMapper vaadinEndpointMapper, ExplicitNullableTypeChecker explicitNullableTypeChecker, javax.servlet.ServletContext servletContext, EndpointRegistry endpointRegistry)	Registers the endpoint invoker.
EndpointNameChecker	endpointNameChecker()	Registers an endpoint name checker responsible for validating the endpoint names.
EndpointRegistry	endpointRegistry(EndpointNameChecker endpointNameChecker)	Registers the endpoint registry.
EndpointUtil	endpointUtil()	Registers endpoint utility methods.
ExplicitNullableTypeChecker	typeChecker()	Registers a ExplicitNullableTypeChecker bean instance.
org.springframework.boot.autoconfigure.web.servlet.WebMvcRegistrations	webMvcRegistrationsHandlerMapping()	Registers EndpointController to use EndpointProperties.getEndpointPrefix() as a prefix for all Vaadin endpoints.

Methods inherited from class java.lang.Object

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

Constructor Detail

EndpointControllerConfiguration

public EndpointControllerConfiguration(EndpointProperties endpointProperties)

Initializes the endpoint configuration.

Parameters:

endpointProperties - Vaadin ednpoint properties

Method Detail

webMvcRegistrationsHandlerMapping

@Bean
public org.springframework.boot.autoconfigure.web.servlet.WebMvcRegistrations webMvcRegistrationsHandlerMapping()

Registers EndpointController to use EndpointProperties.getEndpointPrefix() as a prefix for all Vaadin endpoints.

Returns:

updated configuration for EndpointController

endpointNameChecker

@Bean
public EndpointNameChecker endpointNameChecker()

Registers an endpoint name checker responsible for validating the endpoint names.

Returns:

the endpoint name checker

accessChecker

@Bean
public EndpointAccessChecker accessChecker(com.vaadin.flow.server.auth.AccessAnnotationChecker accessAnnotationChecker)

Registers a default EndpointAccessChecker bean instance.

Parameters:

accessAnnotationChecker - the access controlks checker to use

Returns:

the default Vaadin endpoint access checker bean

accessAnnotationChecker

@Bean
@ConditionalOnMissingBean
public com.vaadin.flow.server.auth.AccessAnnotationChecker accessAnnotationChecker()

Registers a default AccessAnnotationChecker bean instance.

Returns:

the default bean

csrfChecker

@Bean
public CsrfChecker csrfChecker(javax.servlet.ServletContext servletContext)

Registers a default CsrfChecker bean instance.

Parameters:

servletContext - the servlet context

Returns:

the default bean

typeChecker

@Bean
public ExplicitNullableTypeChecker typeChecker()

Registers a ExplicitNullableTypeChecker bean instance.

Returns:

the explicit nullable type checker

endpointUtil

@Bean
public EndpointUtil endpointUtil()

Registers endpoint utility methods.

Returns:

the endpoint util class

endpointRegistry

@Bean
public EndpointRegistry endpointRegistry(EndpointNameChecker endpointNameChecker)

Registers the endpoint registry.

Parameters:

endpointNameChecker - the name checker to use

Returns:

the endpoint registry

endpointInvoker

@Bean
public EndpointInvoker endpointInvoker(org.springframework.context.ApplicationContext applicationContext,
                                       @Autowired(required=false) @Qualifier("vaadinEndpointMapper")
                                       com.fasterxml.jackson.databind.ObjectMapper vaadinEndpointMapper,
                                       ExplicitNullableTypeChecker explicitNullableTypeChecker,
                                       javax.servlet.ServletContext servletContext,
                                       EndpointRegistry endpointRegistry)

Registers the endpoint invoker.

Parameters:

applicationContext - Spring context to extract beans annotated with Endpoint from

vaadinEndpointMapper - optional bean to override the default ObjectMapper that is used for serializing and deserializing request and response bodies Use EndpointController.VAADIN_ENDPOINT_MAPPER_BEAN_QUALIFIER qualifier to override the mapper.

explicitNullableTypeChecker - the method parameter and return value type checker to verify that null values are explicit

servletContext - the servlet context

endpointRegistry - the registry used to store endpoint information

Returns:

the endpoint invoker