Package com.broadleafcommerce.data.tracking.core.type

Enum Class ResolutionIdentifierType

java.lang.Object
java.lang.Enum<ResolutionIdentifierType>
com.broadleafcommerce.data.tracking.core.type.ResolutionIdentifierType
All Implemented Interfaces:
Serializable, Comparable<ResolutionIdentifierType>, Constable
public enum ResolutionIdentifierType extends Enum<ResolutionIdentifierType>
Enumerates the possible types of identifiers available to resolve the tenancy and application context. These identifiers are based on all or part of a given tenant or application's domain or hostname. The default types are DOMAIN and DOMAIN_PREFIX.
Author:
Nathan Moore (nathanmoore).

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    CONTEXT_PATH
    This type indicates that a tenant or application should be resolved based on a matching root context path: my-application in https://www.mycompany.com/my-application.
    DOMAIN
    This type indicates that a tenant or application can be identified based on the whole domain or hostname: myapplication.mycompany.com in https://myapplication.mycompany.com/.
    DOMAIN_PREFIX
    This type indicates that a tenant or application should be resolved based on the first segment of a domain or hostname: myapplication in https://myapplication.mycompany.com/.
    PARAMETER
    This type indicates that a tenant or application should be resolved based on a matching parameter: myapplication in https://mycompany.com?application=myapplication.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ResolutionIdentifierType
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static ResolutionIdentifierType[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • DOMAIN

      public static final ResolutionIdentifierType DOMAIN
      This type indicates that a tenant or application can be identified based on the whole domain or hostname: myapplication.mycompany.com in https://myapplication.mycompany.com/.

    • DOMAIN_PREFIX

      public static final ResolutionIdentifierType DOMAIN_PREFIX
      This type indicates that a tenant or application should be resolved based on the first segment of a domain or hostname: myapplication in https://myapplication.mycompany.com/.

    • PARAMETER

      public static final ResolutionIdentifierType PARAMETER
      This type indicates that a tenant or application should be resolved based on a matching parameter: myapplication in https://mycompany.com?application=myapplication.

    • CONTEXT_PATH

      public static final ResolutionIdentifierType CONTEXT_PATH
      This type indicates that a tenant or application should be resolved based on a matching root context path: my-application in https://www.mycompany.com/my-application.

      IMPORTANT: This will only match the first path segment (from the first / to the second /. The identifier should not include slashes, these will be stripped during resolution.

      Since:
      1.8.6

  • Method Details

    • values

      public static ResolutionIdentifierType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static ResolutionIdentifierType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null