Package org.apache.axis2.deployment

Class WarBasedAxisConfigurator

java.lang.Object
org.apache.axis2.deployment.DeploymentEngine
org.apache.axis2.deployment.WarBasedAxisConfigurator
All Implemented Interfaces:
DeploymentConstants, AxisConfigurator
public class WarBasedAxisConfigurator extends DeploymentEngine implements AxisConfigurator
Processes the init parameters for the AxisServlet. This allows the location of the axis2.xml and the module repository to be different from the default locations. The init parameters support alternate file, or URL values for both of these.

  • Field Details

    • PARAM_AXIS2_XML_PATH

      public static final String PARAM_AXIS2_XML_PATH
      The name of the init parameter (axis2.xml.path) that can be used to override the default location for the axis2.xml file. When both this init parameter, and the axis2.xml.url init parameters are not specified in the axis servlet init-parameter, the default location of ${app}/WEB-INF/conf/axis2.xml is used. The value of this path is interpreted as a file system absolute path. This parameter takes precedence over the axis2.xml.url init parameter.
      See Also:

    • PARAM_AXIS2_XML_URL

      public static final String PARAM_AXIS2_XML_URL
      The name of the init parameter (axis2.xml.url) that when specified indicates the axis2.xml should be loaded using the URL specified as the value of this init parameter. If the axis2.xml.path init parameter is present, this init parameter has no effect.
      See Also:

    • PARAM_AXIS2_REPOSITORY_PATH

      public static final String PARAM_AXIS2_REPOSITORY_PATH
      The name of the init parameter (axis2.repository.path) that when specified indicates the path to the
      See Also:

    • PARAM_AXIS2_REPOSITORY_URL

      public static final String PARAM_AXIS2_REPOSITORY_URL
      The name of the init parameter (axis2.repository.url) that when specified indicates the url to be used
      See Also:

  • Constructor Details

    • WarBasedAxisConfigurator

      public WarBasedAxisConfigurator(jakarta.servlet.ServletConfig servletConfig) throws DeploymentException
      Default constructor for configurator. This determines the axis2.xml file to be used from the init parameters for the AxisServlet in the web.xml. The order of initialization is according the the following precedence:
      • If the parameter axis2.xml.path is present, the value is webapp relative path to be used as the location to the axis2.xml file.
      • Otherwise, if the parameter axis2.xml.url is present, the URL is used as the location to the axis2.xml file.
      • Otherwise, when both of the above init parameters are not present, file is attempted to be loaded from <repo>/WEB-INF/axis2.xml.
      • When none of the above could be found, the axis2.xml is loaded from the classpath resource, the value of DeploymenConstants.AXIS2_CONFIGURATION_RESOURCE.
      Parameters:
      servletConfig - the ServletConfig object from the AxisServlet. This method is called from the init() of the AxisServlet.
      Throws:
      DeploymentException

  • Method Details

    • getAxisConfiguration

      public AxisConfiguration getAxisConfiguration() throws AxisFault
      Gets the axis configuration object by loading the repository. The order of initialization is according the the following precedence:
      • If the parameter axis2.repository.path is present, this folder is used as the location to the repository.
      • Otherwise, if the parameter axis2.repository.url is present, the URL is used as the location to the repository.
      • Otherwise, when both of the above init parameters are not present, the web applications WEB-INF folder is used as the folder for the repository.
      Specified by:
      getAxisConfiguration in interface AxisConfigurator
      Returns:
      the instance of the AxisConfiguration object that reflects the repository according to the rules above.
      Throws:
      AxisFault - when an error occurred in the initialization of the AxisConfiguration.

    • loadServices

      public void loadServices()
      Loads the services within the repository. When the axis2.repository.path init parameter was present, we just call loadServices() in the deployment engine.
      When the axis2.repository.url init parameter was present we load services from the respective URL value of the init parameter.
      Otherwise, try to load the services from the /WEB-INF folder within the web application.
      Specified by:
      loadServices in interface AxisConfigurator
      Overrides:
      loadServices in class DeploymentEngine

    • engageGlobalModules

      public void engageGlobalModules() throws AxisFault
      Description copied from interface: AxisConfigurator
      Engages the global modules specified in the configuration
      Specified by:
      engageGlobalModules in interface AxisConfigurator
      Throws:
      AxisFault

    • setConfigContext

      public void setConfigContext(ConfigurationContext configContext)
      Overrides:
      setConfigContext in class DeploymentEngine