Package org.apache.catalina.storeconfig

Class StoreConfig

  • All Implemented Interfaces:
    IStoreConfig
    public class StoreConfig
extends java.lang.Object
implements IStoreConfig
    Store Server/Service/Host/Context at file or PrintWriter. Default server.xml is at $catalina.base/conf/server.xml

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected static StringManager sm  

    • Constructor Summary

      Constructors 
      Constructor Description
      StoreConfig()  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      StoreRegistry getRegistry()
      Get the StoreRegistry with all factory to generate the server.xml/context.xml files.
      Server getServer()
      Get associated server
      java.lang.String getServerFilename()
      Get server.xml location
      void setRegistry​(StoreRegistry aRegistry)
      set StoreRegistry
      void setServer​(Server aServer)
      Set associated server
      void setServerFilename​(java.lang.String string)
      Set new server.xml location.
      void store​(java.io.PrintWriter aWriter, int indent, Context aContext)
      Store the specified Context properties.
      void store​(java.io.PrintWriter aWriter, int indent, Host aHost)
      Store the specified Host properties.
      void store​(java.io.PrintWriter writer, int indent, Server aServer)
      Store the specified Server properties.
      void store​(java.io.PrintWriter aWriter, int indent, Service aService)
      Store the specified Service properties.
      boolean store​(Context aContext)
      Store the specified Context properties.
      boolean store​(Server aServer)
      Write the configuration information for this entire Server out to the server.xml configuration file.
      void storeConfig()
      Store current Server.
      void storeContext​(java.lang.String aContextName, boolean backup, boolean externalAllowed)
      Store a Context from ObjectName.
      void storeServer​(java.lang.String aServerName, boolean backup, boolean externalAllowed)
      Store Server from Object Name (Catalina:type=Server).

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • StoreConfig

        public StoreConfig()

    • Method Detail

      • getServerFilename

        public java.lang.String getServerFilename()
        Get server.xml location
        Returns:
        The server file name

      • setServerFilename

        public void setServerFilename​(java.lang.String string)
        Set new server.xml location.
        Parameters:
        string - The server.xml location

      • setServer

        public void setServer​(Server aServer)
        Description copied from interface: IStoreConfig
        Set associated server
        Specified by:
        setServer in interface IStoreConfig
        Parameters:
        aServer - the associated server

      • getServer

        public Server getServer()
        Description copied from interface: IStoreConfig
        Get associated server
        Specified by:
        getServer in interface IStoreConfig
        Returns:
        aServer the associated server

      • storeConfig

        public void storeConfig()
        Store current Server.
        Specified by:
        storeConfig in interface IStoreConfig

      • storeServer

        public void storeServer​(java.lang.String aServerName,
                        boolean backup,
                        boolean externalAllowed)
                 throws javax.management.MalformedObjectNameException
        Store Server from Object Name (Catalina:type=Server).
        Parameters:
        aServerName - Server ObjectName
        backup - true to backup existing configuration files before rewriting them
        externalAllowed - true to allow saving webapp configuration for webapps that are not inside the host's app directory
        Throws:
        javax.management.MalformedObjectNameException - Bad MBean name

      • storeContext

        public void storeContext​(java.lang.String aContextName,
                         boolean backup,
                         boolean externalAllowed)
                  throws javax.management.MalformedObjectNameException
        Store a Context from ObjectName.
        Parameters:
        aContextName - MBean ObjectName
        backup - true to backup existing configuration files before rewriting them
        externalAllowed - true to allow saving webapp configuration for webapps that are not inside the host's app directory
        Throws:
        javax.management.MalformedObjectNameException - Bad MBean name

      • store

        public boolean store​(Server aServer)
        Write the configuration information for this entire Server out to the server.xml configuration file.
        Specified by:
        store in interface IStoreConfig
        Parameters:
        aServer - Server instance
        Returns:
        true if the store operation was successful