run.halo.app.theme.TemplateNameResolver Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of api Show documentation

API of halo project, connecting by other projects.

The newest version!

package run.halo.app.theme;

import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

/**
 * The {@link TemplateNameResolver} is used to resolve template name.
 * Halo has a theme mechanism, template files are provided by different themes, so
 * we need a method to determine whether the template file exists in the activated theme and if
 * it does not exist, provide a default template name.
 *
 * @author guqing
 * @since 2.11.0
 */
public interface TemplateNameResolver {

    /**
     * Resolve template name if exists or default template name in classpath.
     *
     * @param exchange exchange to resolve theme to use
     * @param name template
     * @return template name if exists or default template name in classpath
     */
    Mono resolveTemplateNameOrDefault(ServerWebExchange exchange, String name);

    /**
     * Resolve template name if exists or default template given.
     *
     * @param exchange exchange to resolve theme to use
     * @param name template name
     * @param defaultName default template name to use if given template name not exists
     * @return template name if exists or default template name given
     */
    Mono resolveTemplateNameOrDefault(ServerWebExchange exchange, String name,
        String defaultName);

    /**
     * Determine whether the template file exists in the current theme.
     *
     * @param exchange exchange to resolve theme to use
     * @param name template name
     * @return true if the template file exists in the current theme, false otherwise
     */
    Mono isTemplateAvailableInTheme(ServerWebExchange exchange, String name);
}