Package com.vaadin.flow.internal.hilla

Interface EndpointRequestUtil

All Superinterfaces:
Serializable
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

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    EndpointRequestUtil.HillaAvailability
    Holder for the lazily-computed, cached Hilla availability flag.

  • 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.

  • Field Details

  • 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.

      The result is computed once on first access and cached, since the availability of the Hilla endpoint class cannot change during the lifetime of the classloader that loaded this interface.

      Returns:
      true if Hilla is available, false otherwise