Package com.vaadin.hilla

Class EndpointInvoker

java.lang.Object

com.vaadin.hilla.EndpointInvoker

public class EndpointInvoker
extends Object

Handles invocation of endpoint methods after checking the user has proper access.

This class is a generic invoker that does not have knowledge of HTTP requests or the context that the method is being invoked in.

For internal use only. May be renamed or removed in a future release.

Constructor Summary

Constructors

Constructor	Description
EndpointInvoker(org.springframework.context.ApplicationContext applicationContext, tools.jackson.databind.ObjectMapper endpointObjectMapper, ExplicitNullableTypeChecker explicitNullableTypeChecker, jakarta.servlet.ServletContext servletContext, EndpointRegistry endpointRegistry)	Creates an instance of this bean.

Method Summary

Modifier and Type	Method	Description
String	checkAccess(EndpointRegistry.VaadinEndpointData endpointData, Method methodToInvoke, Principal principal, Function<String,Boolean> rolesChecker)
Class<?>	getReturnType(String endpointName, String methodName)	Gets the return type of the given method.
EndpointRegistry.VaadinEndpointData	getVaadinEndpointData(String endpointName)
Object	invoke(String endpointName, String methodName, tools.jackson.databind.node.ObjectNode body, Principal principal, Function<String,Boolean> rolesChecker)	Invoke the given endpoint method with the given parameters if the user has access to do so.

Methods inherited from class java.lang.Object

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

Constructor Details

EndpointInvoker

public EndpointInvoker(org.springframework.context.ApplicationContext applicationContext,
 @Qualifier("hillaEndpointObjectMapper")
 tools.jackson.databind.ObjectMapper endpointObjectMapper,
 ExplicitNullableTypeChecker explicitNullableTypeChecker,
 jakarta.servlet.ServletContext servletContext,
 EndpointRegistry endpointRegistry)

Creates an instance of this bean.

Parameters:

applicationContext - The Spring application context

endpointObjectMapper - The object mapper to be used for serialization and deserialization of request and response bodies. To override the mapper, use the EndpointController.ENDPOINT_MAPPER_FACTORY_BEAN_QUALIFIER qualifier on a JacksonObjectMapperFactory bean definition.

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

Method Details

getReturnType

public Class<?> getReturnType(String endpointName,
 String methodName)

Gets the return type of the given method.

Parameters:

endpointName - the name of the endpoint

methodName - the name of the method

invoke

public Object invoke(String endpointName,
 String methodName,
 tools.jackson.databind.node.ObjectNode body,
 Principal principal,
 Function<String,Boolean> rolesChecker)
              throws EndpointInvocationException.EndpointHttpException

Invoke the given endpoint method with the given parameters if the user has access to do so.

Parameters:

endpointName - the name of the endpoint

methodName - the name of the method in the endpoint

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

principal - the user principal object

rolesChecker - a function for checking if a user is in a given role

Returns:

the return value of the invoked endpoint method, wrapped in a response entity

Throws:

EndpointInvocationException.EndpointHttpException - if thrown by the endpoint

getVaadinEndpointData

public EndpointRegistry.VaadinEndpointData getVaadinEndpointData(String endpointName)
                                                          throws EndpointInvocationException.EndpointNotFoundException

Throws:

EndpointInvocationException.EndpointNotFoundException

checkAccess

public String checkAccess(EndpointRegistry.VaadinEndpointData endpointData,
 Method methodToInvoke,
 Principal principal,
 Function<String,Boolean> rolesChecker)