com.vaadin.flow.internal.hilla.EndpointRequestUtil API 24.6.4 | Vaadin

com.vaadin.flow.internal.hilla.

All Superinterfaces:

All Known Implementing Classes:

public interface EndpointRequestUtil extends Serializable

A container for utility methods related with Hilla endpoints.

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

Since:

23.2

Author:

Vaadin Ltd

Field Summary

Fields

Modifier and Type

Field

Description

static final String

HILLA_ENDPOINT_CLASS
Method Summary

Modifier and Type

Method

Description

boolean

isAnonymousEndpoint(jakarta.servlet.http.HttpServletRequest request)

Checks if the given request goes to an anonymous (public) endpoint.

boolean

isEndpointRequest(jakarta.servlet.http.HttpServletRequest request)

Checks if the request is for an endpoint.

static boolean

isHillaAvailable()

Checks if Hilla is available.

static boolean

isHillaAvailable(ClassFinder classFinder)

Checks if Hilla is available using the given class finder.

Field Details
- HILLA_ENDPOINT_CLASS
  
  static final String HILLA_ENDPOINT_CLASS
  See Also:
  
  Constant Field Values
Method Details
- isEndpointRequest
  
  boolean isEndpointRequest(jakarta.servlet.http.HttpServletRequest request)
  
  Checks if the request is for an endpoint.
  Note even if this method returns true, there is no guarantee that an endpoint method will actually be called, e.g. access might be denied.
  
  Parameters:
  
  request - the HTTP request
  
  Returns:
  
  true if the request is for an endpoint, false otherwise
- isAnonymousEndpoint
  
  boolean isAnonymousEndpoint(jakarta.servlet.http.HttpServletRequest request)
  
  Checks if the given request goes to an anonymous (public) endpoint.
  
  Parameters:
  
  request - the HTTP request to check
  
  Returns:
  
  true if the request goes to an anonymous endpoint, false otherwise
- isHillaAvailable
  
  static boolean isHillaAvailable()
  
  Checks if Hilla is available.
  
  Returns:
  
  true if Hilla is available, false otherwise
- isHillaAvailable
  
  static boolean isHillaAvailable(ClassFinder classFinder)
  
  Checks if Hilla is available using the given class finder.
  
  Parameters:
  
  classFinder - class finder to check the presence of Hilla endpoint class
  
  Returns:
  
  true if Hilla is available, false otherwise