Package com.vaadin.flow.spring.security

Class RequestUtil

java.lang.Object
com.vaadin.flow.spring.security.RequestUtil
@Component public class RequestUtil extends Object
Contains utility methods related to request handling.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RequestUtil()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static org.springframework.security.web.util.matcher.RequestMatcher[]
    antMatchers(String... patterns)
    Utility to create RequestMatchers from ant patterns.
    boolean
    isAnonymousEndpoint(jakarta.servlet.http.HttpServletRequest request)
    Checks whether the request targets an endpoint that is public, i.e.
    boolean
    isAnonymousRoute(jakarta.servlet.http.HttpServletRequest request)
    Checks whether the request targets a Flow route that is public, i.e.
    boolean
    isCustomWebIcon(jakarta.servlet.http.HttpServletRequest request)
    Checks whether the request targets a custom PWA icon or Favicon path.
    boolean
    isEndpointRequest(jakarta.servlet.http.HttpServletRequest request)
    Checks whether the request targets an endpoint.
    boolean
    isFrameworkInternalRequest(jakarta.servlet.http.HttpServletRequest request)
    Checks whether the request is an internal request.
    static org.springframework.security.web.util.matcher.RequestMatcher[]
    routeMatchers(String... patterns)
    Utility to create RequestMatchers for a Vaadin routes, using ant patterns and HTTP get method.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • RequestUtil

      public RequestUtil()

  • Method Details

    • isFrameworkInternalRequest

      public boolean isFrameworkInternalRequest(jakarta.servlet.http.HttpServletRequest request)
      Checks whether the request is an internal request. An internal request is one that is needed for all Vaadin applications to function, e.g. UIDL or init requests. Note that bootstrap requests for any route or static resource requests are not internal, neither are resource requests for the JS bundle.
      Parameters:
      request - the servlet request
      Returns:
      true if the request is Vaadin internal, false otherwise

    • isEndpointRequest

      public boolean isEndpointRequest(jakarta.servlet.http.HttpServletRequest request)
      Checks whether the request targets an endpoint.
      Parameters:
      request - the servlet request
      Returns:
      true if the request is targeting an enpoint, false otherwise

    • isAnonymousEndpoint

      public boolean isAnonymousEndpoint(jakarta.servlet.http.HttpServletRequest request)
      Checks whether the request targets an endpoint that is public, i.e. marked as @AnonymousAllowed.
      Parameters:
      request - the servlet request
      Returns:
      true if the request is targeting an anonymous enpoint, false otherwise

    • isAnonymousRoute

      public boolean isAnonymousRoute(jakarta.servlet.http.HttpServletRequest request)
      Checks whether the request targets a Flow route that is public, i.e. marked as @AnonymousAllowed.
      Parameters:
      request - the servlet request
      Returns:
      true if the request is targeting an anonymous route, false otherwise

    • isCustomWebIcon

      public boolean isCustomWebIcon(jakarta.servlet.http.HttpServletRequest request)
      Checks whether the request targets a custom PWA icon or Favicon path.
      Parameters:
      request - the servlet request
      Returns:
      true if the request is targeting a custom PWA icon or a custom favicon path, false otherwise

    • antMatchers

      public static org.springframework.security.web.util.matcher.RequestMatcher[] antMatchers(String... patterns)
      Utility to create RequestMatchers from ant patterns.
      Parameters:
      patterns - and patterns
      Returns:
      an array or RequestMatcher instances for the given patterns.

    • routeMatchers

      public static org.springframework.security.web.util.matcher.RequestMatcher[] routeMatchers(String... patterns)
      Utility to create RequestMatchers for a Vaadin routes, using ant patterns and HTTP get method.
      Parameters:
      patterns - and patterns
      Returns:
      an array or RequestMatcher instances for the given patterns.