Class ContextName

java.lang.Object
org.apache.catalina.util.ContextName
public final class ContextName extends Object
Utility class to manage context names so there is one place where the conversions between baseName, path and version take place.

  • Field Details

  • Constructor Details

    • ContextName

      public ContextName(String name, boolean stripFileExtension)
      Creates an instance from a context name, display name, base name, directory name, WAR name or context.xml name.
      Parameters:
      name - The name to use as the basis for this object
      stripFileExtension - If a .war or .xml file extension is present at the end of the provided name should it be removed?

    • ContextName

      public ContextName(String path, String version)
      Construct an instance from a path and version.
      Parameters:
      path - Context path to use
      version - Context version to use

  • Method Details

    • getBaseName

      public String getBaseName()
      Returns the base name of this context.
      Returns:
      the base name

    • getPath

      public String getPath()
      Returns the path of this context.
      Returns:
      the context path

    • getVersion

      public String getVersion()
      Returns the version of this context.
      Returns:
      the context version

    • getName

      public String getName()
      Returns the name of this context.
      Returns:
      the context name

    • getDisplayName

      public String getDisplayName()
      Returns the display name of this context.
      Returns:
      the display name

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • isPathValid

      public boolean isPathValid()
      Checks if the path for this instance is valid.
      Returns:
      true if the path given/calculated for this instance is valid, otherwise false

    • extractFromPath

      public static ContextName extractFromPath(String path)
      Extract the final component of the given path which is assumed to be a base name and generate a ContextName from that base name.
      Parameters:
      path - The path that ends in a base name
      Returns:
      the ContextName generated from the given base name