Package de.xima.fc.security.interfaces.endpoint.uri

Interface IUriResolver

All Superinterfaces:
Serializable
All Known Subinterfaces:
IRewriteUriResolver
public interface IUriResolver extends Serializable
Common interface for URI resolvers of IWebEndpoint. URI resolvers define the (internal and external) location of web endpoints.
Since:
8.0.0
Author:
XIMA Media GmbH

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotBlank String
    buildUri(IUriBuilderContext context)
    Builds the URI with the given context.
    boolean
    matches(javax.servlet.http.HttpServletRequest request)
    Checks whether the request matches the URI of the web endpoint defined by this resolver.

  • Method Details

    • buildUri

      @NotBlank @NotBlank String buildUri(IUriBuilderContext context)
      Builds the URI with the given context.
      Parameters:
      context - for resolving the URI. The context determines scopes for which to build the URI, such as for which client to build a URI.
      Returns:
      the built URI.

    • matches

      boolean matches(javax.servlet.http.HttpServletRequest request)
      Checks whether the request matches the URI of the web endpoint defined by this resolver.
      Parameters:
      request - to be checked.
      Returns:
      true if the given request matches the URI of the web endpoint defined by this resolver and false otherwise.