com.vaadin.flow.server.connect.

Class VaadinConnectController


  • public class VaadinConnectController
extends Object

    The controller that is responsible for processing Vaadin Connect requests. Each class that is annotated with Endpoint gets its public methods exposed so that those can be triggered by a correct POST request, including the methods inherited from the other classes, excluding Object class ones. Other methods (non-public) are not considered by the controller.

    For example, if a class with name TestClass that has the only public method testMethod was annotated with the annotation, it can be called via http://${base_url}/testclass/testmethod POST call, where ${base_url} is the application base url, configured by the user. Class name and method name case in the request URL does not matter, but if the method has parameters, the request body should contain a valid JSON with all parameters in the same order as they are declared in the method. The parameter types should also correspond for the request to be successful.

    • Constructor Detail

      • VaadinConnectController

        public VaadinConnectController(com.fasterxml.jackson.databind.ObjectMapper vaadinEndpointMapper,
                               VaadinConnectAccessChecker accessChecker,
                               EndpointNameChecker endpointNameChecker,
                               ExplicitNullableTypeChecker explicitNullableTypeChecker,
                               ApplicationContext context)

        A constructor used to initialize the controller.

        Parameters:

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

        accessChecker - the ACL checker to verify the endpoint method access permissions

        endpointNameChecker - the endpoint name checker to verify custom Vaadin Connect endpoint names

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

        context - Spring context to extract beans annotated with Endpoint from

    • Method Detail

      • serveEndpoint

        public <any> serveEndpoint(String endpointName,
                           String methodName,
                           com.fasterxml.jackson.databind.node.ObjectNode body,
                           HttpServletRequest request)

        Captures and processes the Vaadin Connect requests.

        Matches the endpoint name and a method name with the corresponding Java class and a public method in the class. Extracts parameters from a request body if the Java method requires any and applies in the same order. After the method call, serializes the Java method execution result and sends it back.

        If an issue occurs during the request processing, an error response is returned instead of the serialized Java method return value.

        Parameters:

        endpointName - the name of an endpoint to address the calls to, not case sensitive

        methodName - the method name to execute on an endpoint, not case sensitive

        body - optional request body, that should be specified if the method called has parameters

        request - the current request which triggers the endpoint call

        Returns:

        execution result as a JSON string or an error message string