Interface PathConverter

All Known Implementing Classes:
AbstractPathConverter, BlogPathConverter, PagePathConverter, SpacePathConverter, UserPathConverter, ViewPageActionPathConverter

public interface PathConverter
Path converters are used by the SimpleDisplayServlet to convert friendly URL's to action URLs.
  • Method Summary

    Modifier and Type
    Method
    Description
    Deprecated.
    since 6.0.
    getPath(String path, String queryString)
    Returns a ConvertedPath based on the passed in path and query string.
    default boolean
    Deprecated.
    since 6.0.
    default boolean
    handles(String path, String queryString)
    Return true from this method if your path converter can convert the specified path and query string.
  • Method Details

    • handles

      @Deprecated default boolean handles(String path)
      Deprecated.
      since 6.0. Use handles(String, String) instead.
    • getPath

      @Deprecated default ConvertedPath getPath(String path)
      Deprecated.
      since 6.0. Use getPath(String, String) instead.
    • handles

      default boolean handles(String path, String queryString)
      Return true from this method if your path converter can convert the specified path and query string. By default, the SimpleDisplayServlet will be mapped to '/display' which will be stripped off the path before being passed to this method. The first converter that returns true for a path will be used to perform the conversion.
      Parameters:
      path - the path relative to the servlet mapping
      queryString - the query string
      Returns:
      true if your path converter can handle this path
    • getPath

      default ConvertedPath getPath(String path, String queryString)
      Returns a ConvertedPath based on the passed in path and query string.
      Parameters:
      path - the path relative to the servlet mapping
      queryString - the query string
      Returns:
      a ConvertedPath representing the path conversion