Interface LinkHelper

All Superinterfaces:
PathHelper
All Known Implementing Classes:
MvcLinkHelper, ResourcesLinkHelper

public interface LinkHelper extends PathHelper
A marker interface for link helpers. A link helper is a PathHelper which constructs paths in such a way that they are suitable for use in links.

The contract which all implementations of this interface must respect is:

  • the constructed paths MUST include the application context path
  • the constructed paths MUST include any applicable servlet path
  • the constructed paths MUST be absolute (see below for clarification)

Link helpers extend the definition of an absolute path (see PathHelper) by also allowing full URL paths which include scheme, host and optional port (eg. http://localhost:8080/example-app/example-servlet/example-endpoint

Since:
10.0
Author:
Petru Galanton