Package io.wcm.handler.url.integrator

Interface IntegratorHandler

  • @ProviderType
public interface IntegratorHandler
    Manages detection of integrator template context.

    The interface is implemented by a Sling Model. You can adapt from SlingHttpServletRequest or Resource to get a context-specific handler instance.

    • Field Detail

      • SELECTOR_INTEGRATORTEMPLATE

        @NotNull
static final @NotNull java.lang.String SELECTOR_INTEGRATORTEMPLATE
        Selector for "integrator template" mode.
        See Also:
        Constant Field Values

      • SELECTOR_INTEGRATORTEMPLATE_SECURE

        @NotNull
static final @NotNull java.lang.String SELECTOR_INTEGRATORTEMPLATE_SECURE
        Selector for "integrator template" secure mode.
        See Also:
        Constant Field Values

    • Method Detail

      • isIntegratorTemplateMode

        boolean isIntegratorTemplateMode()
        Checks if current request is in integrator template mode.
        Returns:
        true if in integrator template mode

      • isIntegratorTemplateSecureMode

        boolean isIntegratorTemplateSecureMode()
        Checks if current request is in integrator secure template mode.
        Returns:
        true if in integrator template secure mode

      • getIntegratorTemplateSelector

        @NotNull
@NotNull java.lang.String getIntegratorTemplateSelector()
        Returns selector for integrator template mode. In HTTPS mode the secure selector is returned, otherwise the default selector. HTTPS mode is active if the current page is an integrator page and has simple mode-HTTPs activated, or the secure integrator mode selector is included in the current request.
        Returns:
        Integrator template selector

      • getIntegratorMode

        @NotNull
@NotNull IntegratorMode getIntegratorMode()
        Get integrator mode configured for the current page.
        Returns:
        Integrator mode

      • getIntegratorMode

        @NotNull
@NotNull IntegratorMode getIntegratorMode​(@Nullable
                                          @Nullable com.day.cq.wcm.api.Page page)
        Get integrator mode configured for the given page.
        Parameters:
        page - Page
        Returns:
        Integrator mode