com.atlassian.confluence.servlet.simpledisplay
Interface PathConverter

All Known Implementing Classes:
AbstractPathConverter, BlogPathConverter, MailPathConverter, PagePathConverter, SpacePathConverter, UserPathConverter, UserStatusListPathConverter, UserStatusPathConverter

public interface PathConverter

Path converters are used by the SimpleDisplayServlet to convert friendly URL's to action URLs.


Method Summary
 ConvertedPath getPath(String path)
          Returns a ConvertedPath based on the passed in path.
 boolean handles(String path)
          Return true from this method if your path converter can convert the specified path.
 

Method Detail

handles

boolean handles(String path)
Return true from this method if your path converter can convert the specified path. 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
Returns:
true if your path converter can handle this path

getPath

ConvertedPath getPath(String path)
Returns a ConvertedPath based on the passed in path.

Parameters:
path - the path relative to the servlet mapping
Returns:
a ConvertedPath representing the path conversion


Copyright © 2003-2013 Atlassian. All Rights Reserved.