io.wcm.handler.url.UrlModes Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of io.wcm.handler.url Show documentation
URL resolving and processing.
There is a newer version: 2.1.0
/*
 * #%L
 * wcm.io
 * %%
 * Copyright (C) 2014 wcm.io
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */
package io.wcm.handler.url;

import org.jetbrains.annotations.NotNull;

import io.wcm.handler.url.impl.modes.DefaultUrlMode;
import io.wcm.handler.url.impl.modes.FullUrlForceNonSecureUrlMode;
import io.wcm.handler.url.impl.modes.FullUrlForceSecureUrlMode;
import io.wcm.handler.url.impl.modes.FullUrlProtocolRelativeUrlMode;
import io.wcm.handler.url.impl.modes.FullUrlUrlMode;
import io.wcm.handler.url.impl.modes.NoHostnameUrlMode;

/**
 * Default URL modes sufficient for the most usecases.
 */
public final class UrlModes {

  private UrlModes() {
    // constants only
  }

  /**
   * Default mode: Does generate a full externalized URL only if both siteUrl and siteUrlSecure parameter
   * are set in context-specific configuration. If not set, only URLs without hostname are generated.
   * 
   * If the target is an internal content page, siteUrl or siteUrlSecure is chosen automatically depending on the secure
   * state of the page.
   * 
   */
  public static final @NotNull UrlMode DEFAULT = new DefaultUrlMode();

  /**
   * Does generate a externalized URL without any protocol and hostname,
   * independent of any setting in context-specific configuration.
   */
  public static final @NotNull UrlMode NO_HOSTNAME = new NoHostnameUrlMode();

  /**
   * Enforce the generation of a full URL with protocol and hostname.
   * 
   * If the target is an internal content page, siteUrl or siteUrlSecure is chosen automatically depending on the secure
   * state of page.
   * 
   * 
   * On author instance always the author URL is used.
   * 
   */
  public static final @NotNull UrlMode FULL_URL = new FullUrlUrlMode(false);

  /**
   * Enforce the generation of a full URL with protocol and hostname and non-secure mode.
   * 
   * On author instance always the author URL is used.
   * 
   */
  public static final @NotNull UrlMode FULL_URL_FORCENONSECURE = new FullUrlForceNonSecureUrlMode(false);

  /**
   * Enforce the generation of a full URL with protocol and hostname and secure mode.
   * 
   * If siteUrlSecure is not set, siteUrl is used.
   * 
   * 
   * On author instance always the author URL is used.
   * 
   */
  public static final @NotNull UrlMode FULL_URL_FORCESECURE = new FullUrlForceSecureUrlMode(false);

  /**
   * Enforce the generation of a full URL with hostname and "//" as protocol (protocol-relative mode).
   * 
   * Using "//" instead of "http://" or "https://" results in using the same protocol as the current request in the
   * browser.
   * 
   * 
   * On author instance always the author URL is used.
   * 
   */
  public static final @NotNull UrlMode FULL_URL_PROTOCOLRELATIVE = new FullUrlProtocolRelativeUrlMode(false);

  /**
   * Enforce the generation of a full URL with protocol and hostname.
   * 
   * If the target is an internal content page, siteUrl or siteUrlSecure is chosen automatically depending on the secure
   * state of page.
   * 
   * 
   * Always uses the Site URLs configured for the publish instance, even if running on an author instance.
   * 
   */
  public static final @NotNull UrlMode FULL_URL_PUBLISH = new FullUrlUrlMode(true);

  /**
   * Enforce the generation of a full URL with protocol and hostname and non-secure mode.
   * 
   * Always uses the Site URLs configured for the publish instance, even if running on an author instance.
   * 
   */
  public static final @NotNull UrlMode FULL_URL_PUBLISH_FORCENONSECURE = new FullUrlForceNonSecureUrlMode(true);

  /**
   * Enforce the generation of a full URL with protocol and hostname and secure mode.
   * 
   * If siteUrlSecure is not set, siteUrl is used.
   * 
   * 
   * Always uses the Site URLs configured for the publish instance, even if running on an author instance.
   * 
   */
  public static final @NotNull UrlMode FULL_URL_PUBLISH_FORCESECURE = new FullUrlForceSecureUrlMode(true);

  /**
   * Enforce the generation of a full URL with hostname and "//" as protocol (protocol-relative mode).
   * 
   * Using "//" instead of "http://" or "https://" results in using the same protocol as the current request in the
   * browser.
   * 
   * 
   * Always uses the Site URLs configured for the publish instance, even if running on an author instance.
   * 
   */
  public static final @NotNull UrlMode FULL_URL_PUBLISH_PROTOCOLRELATIVE = new FullUrlProtocolRelativeUrlMode(true);

}