Interface IUserPortalRouterUrlHandler<Context extends IRoutingContext>

Type Parameters:
Context - The type of the context data required to route to the URL.
public interface IUserPortalRouterUrlHandler<Context extends IRoutingContext>
Handles URLs for the user portal.

  • Method Summary

    Modifier and Type
    Method
    Description
    Context
    extractContextFromRequest(javax.servlet.http.HttpServletRequest request)
    Extracts the context data from an HTTP request.
    boolean
    matches(javax.servlet.http.HttpServletRequest request)
    Checks if the given request matches this route.
    Class<? extends Context>
    requiredContext()
    Gets the runtime class of the type parameter.
    String
    toExternalUrl(Context context)
    Creates the external URL, using the given context data.
    String
    toInternalUrl(Context context)
    Creates the internal URL, using the given context data.

  • Method Details

    • extractContextFromRequest

      Context extractContextFromRequest(javax.servlet.http.HttpServletRequest request)
      Extracts the context data from an HTTP request.
      Parameters:
      request - The HTTP request to extract the context data from.
      Returns:
      The context data extracted from the request.

    • matches

      boolean matches(javax.servlet.http.HttpServletRequest request)
      Checks if the given request matches this route.
      Parameters:
      request - The request to check.
      Returns:
      True if the request matches this route, false otherwise.

    • requiredContext

      Class<? extends Context> requiredContext()
      Gets the runtime class of the type parameter.
      Returns:
      The runtime class of the type parameter.

    • toExternalUrl

      String toExternalUrl(Context context)
      Creates the external URL, using the given context data. The external URL is visible to clients in the browser.
      Parameters:
      context - The context data to use for creating the URL.
      Returns:
      The external URL.

    • toInternalUrl

      String toInternalUrl(Context context)
      Creates the internal URL, using the given context data. The external URL is used internally on the server.
      Parameters:
      context - The context data to use for creating the URL.
      Returns:
      The internal URL.