com.sdl.webapp.common.api.content.LinkResolver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dxa-common Show documentation

DXA Common project contains framework common classes shared between all other artifacts

There is a newer version: 2.3.7

package com.sdl.webapp.common.api.content;

/**
 * Link resolver that resolves links to components.
 *
 */
@FunctionalInterface
public interface LinkResolver {

    /**
     * Resolves a link. This translates the input URL to a link that can be used on a web page. What the input URL
     * is exactly depends on the implementation and what the source of the data is - it might for example be a Tridion
     * "tcm:" URL which refers to a Tridion component.
     *
     * @param url             The TCM URI to resolve.
     * @param localizationId  The localization ID to use.
     * @param resolveToBinary whether the expected URL is an URL to a binary
     * @return The translated URL.
     */
    default String resolveLink(String url, String localizationId, boolean resolveToBinary){
        return resolveLink(url, localizationId, resolveToBinary, null);
    }

    /**
     * Resolves a link. This translates the input URL to a link that can be used on a web page. What the input URL
     * is exactly depends on the implementation and what the source of the data is - it might for example be a Tridion
     * "tcm:" URL which refers to a Tridion component.
     *
     * @param url            The TCM URI to resolve.
     * @param localizationId The localization ID to use.
     * @return The translated URL.
     */
    default String resolveLink(String url, String localizationId) {
        return resolveLink(url, localizationId, false, null);
    }

    /**
     * Resolves a link. This translates the input URL to a link that can be used on a web page. What the input URL
     * is exactly depends on the implementation and what the source of the data is - it might for example be a Tridion
     * "tcm:" URL which refers to a Tridion component.
     *
     * @param url            The TCM URI to resolve.
     * @param localizationId The localization ID to use.
     * @param contextId The ID of the context page within which we are resolving
     * @return The translated URL.
     */
    default String resolveLink(String url, String localizationId, String contextId) {
        return resolveLink(url, localizationId, false, contextId);
    }

    /**
     * Resolves a link. This translates the input URL to a link that can be used on a web page. What the input URL
     * is exactly depends on the implementation and what the source of the data is - it might for example be a Tridion
     * "tcm:" URL which refers to a Tridion component.
     *
     * @param url             The TCM URI to resolve.
     * @param localizationId  The localization ID to use.
     * @param resolveToBinary whether the expected URL is an URL to a binary
     * @param contextId The ID of the context page within which we are resolving
     * @return The translated URL.
     */
    String resolveLink(String url, String localizationId, boolean resolveToBinary, String contextId);
}