org.broadleafcommerce.cms.url.service

Interface URLHandlerService

All Known Implementing Classes:

URLHandlerServiceImpl

public interface URLHandlerService

Created by bpolster.

Method Summary

Modifier and Type	Method and Description
String	buildURLHandlerCacheKey(Site site, String requestUri)
List<URLHandler>	findAllRegexURLHandlers() This is assumed to be a relatively small list of regex URLHandlers (perhaps in the dozens or hundreds of records at a maximum).
List<URLHandler>	findAllURLHandlers() Be cautious when calling this.
URLHandler	findURLHandlerById(Long id) Finds a URLHandler by its ID.
URLHandler	findURLHandlerByURI(String uri) Checks the passed in URL to determine if there is a matching URLHandler.
Boolean	removeURLHandlerFromCache(String mapKey)
URLHandler	saveURLHandler(URLHandler handler) Persists the URLHandler to the DB.

Method Detail

findURLHandlerByURI

URLHandler findURLHandlerByURI(String uri)

Checks the passed in URL to determine if there is a matching URLHandler. Returns null if no handler was found.

Parameters:

uri -

Returns:

findAllURLHandlers

List<URLHandler> findAllURLHandlers()

Be cautious when calling this. If there are a large number of records, this can cause performance and memory issues.

Returns:

saveURLHandler

URLHandler saveURLHandler(URLHandler handler)

Persists the URLHandler to the DB.

Parameters:

handler -

Returns:

findURLHandlerById

URLHandler findURLHandlerById(Long id)

Finds a URLHandler by its ID.

Parameters:

id -

Returns:

findAllRegexURLHandlers

List<URLHandler> findAllRegexURLHandlers()

This is assumed to be a relatively small list of regex URLHandlers (perhaps in the dozens or hundreds of records at a maximum). Having large number of records here (more 1000, for example) is not likely necessary to accomplish the desired goal, and can cause performance problems.

Returns:

buildURLHandlerCacheKey

String buildURLHandlerCacheKey(Site site,
                               String requestUri)

removeURLHandlerFromCache

Boolean removeURLHandlerFromCache(String mapKey)