Class ConnectorStoreAppender

java.lang.Object
org.apache.catalina.storeconfig.StoreAppender
org.apache.catalina.storeconfig.ConnectorStoreAppender
public class ConnectorStoreAppender extends StoreAppender
Specialized StoreAppender for persisting Connector instances to XML configuration.

A Connector acts as a wrapper around a ProtocolHandler, meaning configuration attributes are spread across both objects. This appender collects properties from the Connector, its ProtocolHandler, and its SocketProperties, applying the following transformations during persistence:

  • Maps certain attribute names to their XML equivalents (e.g., timeout to connectionUploadTimeout)
  • Filters internal executor attributes when an external executor is configured
  • Prefixes socket properties with socket.
  • Suppresses default values by comparing against a freshly created Connector
  • Handles special cases such as jkHome and catalina.base path resolution
See Also:

  • Field Details

    • replacements

      protected static final HashMap<String,String> replacements
      Map of attribute name replacements for connector properties.

    • internalExecutorAttributes

      protected static final Set<String> internalExecutorAttributes
      Set of attribute names that belong to the internal executor.

  • Constructor Details

    • ConnectorStoreAppender

      public ConnectorStoreAppender()
      Creates a new ConnectorStoreAppender instance.

  • Method Details

    • printAttributes

      public void printAttributes(PrintWriter writer, int indent, boolean include, Object bean, StoreDescription desc) throws Exception
      Description copied from class: StoreAppender
      Store the relevant attributes of the specified JavaBean.
      Overrides:
      printAttributes in class StoreAppender
      Parameters:
      writer - PrintWriter to which we are storing
      indent - Indentation level
      include - Should we include a className attribute?
      bean - Bean whose properties are to be rendered as attributes,
      desc - Store description from this bean
      Throws:
      Exception - if an exception occurs while storing

    • getPropertyKeys

      protected List<String> getPropertyKeys(Connector bean) throws IntrospectionException
      Get all properties from Connector and current ProtocolHandler.
      Parameters:
      bean - The connector
      Returns:
      List of Connector property names
      Throws:
      IntrospectionException - Error introspecting connector

    • storeConnectorAttributes

      protected void storeConnectorAttributes(PrintWriter aWriter, int indent, Object bean, StoreDescription aDesc) throws Exception
      Print Attributes for the connector
      Parameters:
      aWriter - Current writer
      indent - Indentation level
      bean - The connector bean
      aDesc - The connector description
      Throws:
      Exception - Store error occurred

    • printOpenTag

      public void printOpenTag(PrintWriter aWriter, int indent, Object bean, StoreDescription aDesc) throws Exception
      Description copied from class: StoreAppender
      Print only the open tag with all attributes.
      Overrides:
      printOpenTag in class StoreAppender
      Parameters:
      aWriter - The output writer
      indent - Indentation level
      bean - The current bean that is stored
      aDesc - Store description of the current element
      Throws:
      Exception - A store error occurred

    • printTag

      public void printTag(PrintWriter aWriter, int indent, Object bean, StoreDescription aDesc) throws Exception
      Description copied from class: StoreAppender
      Print tag with all attributes
      Overrides:
      printTag in class StoreAppender
      Parameters:
      aWriter - The output writer
      indent - Indentation level
      bean - The current bean that is stored
      aDesc - Store description of the current element
      Throws:
      Exception - A store error occurred

    • printValue

      public void printValue(PrintWriter writer, int indent, String name, Object value)
      Description copied from class: StoreAppender
      Print an attribute value.
      Overrides:
      printValue in class StoreAppender
      Parameters:
      writer - PrintWriter to which we are storing
      indent - Indentation level
      name - Attribute name
      value - Attribute value

    • isPrintValue

      public boolean isPrintValue(Object bean, Object bean2, String attrName, StoreDescription desc)
      Print Connector Values.
      • Special handling to default jkHome.
      • Don't save catalina.base path at server.xml
      Overrides:
      isPrintValue in class StoreAppender
      Parameters:
      bean - original bean
      bean2 - default bean
      attrName - attribute name
      desc - Store description from this bean
      Returns:
      true if the value should be stored
      See Also:

    • getCatalinaBase

      protected File getCatalinaBase()
      Returns the canonical catalina base directory.
      Returns:
      the catalina base file path

    • getJkHomeBase

      protected File getJkHomeBase(String jkHome, File appBase)
      Returns the canonical JK home base directory.
      Parameters:
      jkHome - the JK home path
      appBase - the application base directory
      Returns:
      the canonical JK home file path