com.vaadin.flow.server.connect

Class VaadinConnectControllerConfiguration

java.lang.Object

com.vaadin.flow.server.connect.VaadinConnectControllerConfiguration

public class VaadinConnectControllerConfiguration
extends Object

A configuration class for customizing the VaadinConnectController class.

Constructor Summary

Constructors

Constructor and Description
VaadinConnectControllerConfiguration(VaadinEndpointProperties vaadinEndpointProperties) Initializes the endpoint configuration.

Method Summary

Modifier and Type	Method and Description
AccessAnnotationChecker	accessAnnotationChecker() Registers a default AccessAnnotationChecker bean instance.
VaadinConnectAccessChecker	accessChecker(AccessAnnotationChecker accessAnnotationChecker, CsrfChecker csrfChecker) Registers a default VaadinConnectAccessChecker bean instance.
CsrfChecker	csrfChecker() Registers a default CsrfChecker bean instance.
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.
WebMvcRegistrations	webMvcRegistrationsHandlerMapping() Registers VaadinConnectController to use VaadinEndpointProperties.getVaadinEndpointPrefix() 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

VaadinConnectControllerConfiguration

public VaadinConnectControllerConfiguration(VaadinEndpointProperties vaadinEndpointProperties)

Initializes the endpoint configuration.

Parameters:

vaadinEndpointProperties - Vaadin ednpoint properties

Method Detail

webMvcRegistrationsHandlerMapping

public WebMvcRegistrations webMvcRegistrationsHandlerMapping()

Registers VaadinConnectController to use VaadinEndpointProperties.getVaadinEndpointPrefix() as a prefix for all Vaadin endpoints.

Returns:

updated configuration for VaadinConnectController

endpointNameChecker

public EndpointNameChecker endpointNameChecker()

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

Returns:

the endpoint name checker

accessChecker

public VaadinConnectAccessChecker accessChecker(AccessAnnotationChecker accessAnnotationChecker,
                                                CsrfChecker csrfChecker)

Registers a default VaadinConnectAccessChecker bean instance.

Parameters:

accessAnnotationChecker - the access controlks checker to use

csrfChecker - the CSRF checker to use

Returns:

the default Vaadin endpoint access checker bean

accessAnnotationChecker

public AccessAnnotationChecker accessAnnotationChecker()

Registers a default AccessAnnotationChecker bean instance.

Returns:

the default bean

csrfChecker

public CsrfChecker csrfChecker()

Registers a default CsrfChecker bean instance.

Returns:

the default bean

typeChecker

public ExplicitNullableTypeChecker typeChecker()

Registers a ExplicitNullableTypeChecker bean instance.

Returns:

the explicit nullable type checker

endpointUtil

public EndpointUtil endpointUtil()

Registers endpoint utility methods.

Returns:

the endpoint util class

endpointRegistry

public EndpointRegistry endpointRegistry(EndpointNameChecker endpointNameChecker)

Registers the endpoint registry.

Parameters:

endpointNameChecker - the name checker to use

Returns:

the endpoint registry