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 TypeMethodDescriptiondefault ConvertedPath
Deprecated.since 6.0.default ConvertedPath
Returns aConvertedPath
based on the passed in path and query string.default boolean
Deprecated.since 6.0.default boolean
Return true from this method if your path converter can convert the specified path and query string.
-
Method Details
-
handles
Deprecated.since 6.0. Usehandles(String, String)
instead. -
getPath
Deprecated.since 6.0. UsegetPath(String, String)
instead. -
handles
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 mappingqueryString
- the query string- Returns:
- true if your path converter can handle this path
-
getPath
Returns aConvertedPath
based on the passed in path and query string.- Parameters:
path
- the path relative to the servlet mappingqueryString
- the query string- Returns:
- a
ConvertedPath
representing the path conversion
-