VanityMode.java

/*
 * #%L
 * wcm.io
 * %%
 * Copyright (C) 2024 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;

/**
 * Vanity mode to use when building URLs pointing to AEM pages.
 */
public enum VanityMode {

  /**
   * Ignore vanity paths for AEM pages.
   */
  NEVER,

  /**
   * Only use vanity paths when externalizing URLs for AEM pages.
   */
  EXTERNALIZE,

  /**
   * Always use vanity paths for AEM pages.
   */
  ALWAYS

}