Package org.apache.catalina.startup

Class UserConfig

  • All Implemented Interfaces:
    LifecycleListener
    public final class UserConfig
extends java.lang.Object
implements LifecycleListener
    Startup event listener for a Host that configures Contexts (web applications) for all defined "users" who have a web application in a directory with the specified name in their home directories. The context path of each deployed application will be set to ~xxxxx, where xxxxx is the username of the owning user for that web application

    • Constructor Summary

      Constructors 
      Constructor Description
      UserConfig()
      Constructs a new UserConfig.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getAllow()
      Returns the regular expression that defines allowed users.
      java.lang.String getConfigClass()
      Returns the Context configuration class name.
      java.lang.String getContextClass()
      Returns the Context implementation class name.
      java.lang.String getDeny()
      Returns the regular expression that defines denied users.
      java.lang.String getDirectoryName()
      Returns the directory name for user web applications.
      java.lang.String getHomeBase()
      Returns the base directory containing user home directories.
      java.lang.String getUserClass()
      Returns the user database class name.
      void lifecycleEvent​(LifecycleEvent event)
      Process the START and STOP events for an associated Host.
      void setAllow​(java.lang.String allow)
      Set the regular expression used to test for user who deployment is allowed.
      void setConfigClass​(java.lang.String configClass)
      Sets the Context configuration class name.
      void setContextClass​(java.lang.String contextClass)
      Sets the Context implementation class name.
      void setDeny​(java.lang.String deny)
      Set the regular expression used to test for user who deployment is denied.
      void setDirectoryName​(java.lang.String directoryName)
      Sets the directory name for user web applications.
      void setHomeBase​(java.lang.String homeBase)
      Sets the base directory containing user home directories.
      void setUserClass​(java.lang.String userClass)
      Sets the user database class name.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • UserConfig

        public UserConfig()
        Constructs a new UserConfig.

    • Method Detail

      • getConfigClass

        public java.lang.String getConfigClass()
        Returns the Context configuration class name.
        Returns:
        the Context configuration class name

      • setConfigClass

        public void setConfigClass​(java.lang.String configClass)
        Sets the Context configuration class name.
        Parameters:
        configClass - The new Context configuration class name

      • getContextClass

        public java.lang.String getContextClass()
        Returns the Context implementation class name.
        Returns:
        the Context implementation class name

      • setContextClass

        public void setContextClass​(java.lang.String contextClass)
        Sets the Context implementation class name.
        Parameters:
        contextClass - The new Context implementation class name

      • getDirectoryName

        public java.lang.String getDirectoryName()
        Returns the directory name for user web applications.
        Returns:
        the directory name

      • setDirectoryName

        public void setDirectoryName​(java.lang.String directoryName)
        Sets the directory name for user web applications.
        Parameters:
        directoryName - The new directory name

      • getHomeBase

        public java.lang.String getHomeBase()
        Returns the base directory containing user home directories.
        Returns:
        the base directory

      • setHomeBase

        public void setHomeBase​(java.lang.String homeBase)
        Sets the base directory containing user home directories.
        Parameters:
        homeBase - The new base directory

      • getUserClass

        public java.lang.String getUserClass()
        Returns the user database class name.
        Returns:
        the user database class name

      • setUserClass

        public void setUserClass​(java.lang.String userClass)
        Sets the user database class name.
        Parameters:
        userClass - The user database class name

      • getAllow

        public java.lang.String getAllow()
        Returns the regular expression that defines allowed users.
        Returns:
        the allow pattern, or null if all users are allowed

      • setAllow

        public void setAllow​(java.lang.String allow)
        Set the regular expression used to test for user who deployment is allowed.
        Parameters:
        allow - The new allow expression

      • getDeny

        public java.lang.String getDeny()
        Returns the regular expression that defines denied users.
        Returns:
        the deny pattern, or null if no users are denied

      • setDeny

        public void setDeny​(java.lang.String deny)
        Set the regular expression used to test for user who deployment is denied.
        Parameters:
        deny - The new deny expression

      • lifecycleEvent

        public void lifecycleEvent​(LifecycleEvent event)
        Process the START and STOP events for an associated Host.
        Specified by:
        lifecycleEvent in interface LifecycleListener
        Parameters:
        event - The lifecycle event that has occurred