Package org.broadleafcommerce.cms.web

Interface URLProcessor

All Known Implementing Classes:
NullURLProcessor
public interface URLProcessor
Deprecated.
This interface is intended for use by processors that will determine whether a given URL requires special treatment.

Specifically, certain URLs refer to custom managed content pages. Others are setup as SEO friendly URLs for products.

The ProcessURLFilter will check it's internal cache to determine which URL processor should be invoked for a passed in URL. If it is unable to find a matching processor in cache, then it will call each processor in turn to provide an attempt to process the URL.

Created by bpolster.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canProcessURL(String key)
    Deprecated.
    Implementors of this interface will return true if they are able to process the passed in request.
    boolean
    processURL(String key)
    Deprecated.
    Implementers of this interface will process the passed in request.

  • Method Details

    • canProcessURL

      boolean canProcessURL(String key)
      Deprecated.
      Implementors of this interface will return true if they are able to process the passed in request.

      Implementors of this method will need to rely on the BroadleafRequestContext class which provides access to the current sandbox, locale, request, and response via a threadlocal context

      Parameters:
      key -
      Returns:
      true if the passed in key can be processed by this processor.

    • processURL

      boolean processURL(String key) throws IOException, jakarta.servlet.ServletException
      Deprecated.
      Implementers of this interface will process the passed in request.

      Implementors of this method will need to rely on the BroadleafRequestContext class which provides access to the current sandbox, locale, request, and response via a threadlocal context

      Returns:
      true if the processor was able to process the passed in URL.
      Throws:
      IOException
      jakarta.servlet.ServletException