axis2/java/core/docs/webadminguide.html - axis-site - Git at Google

 <!DOCTYPE html>


 <!--
  | Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/xdoc/docs/webadminguide.xml at 2025-03-05
  | Rendered using Apache Maven Fluido Skin 2.0.0-M11
 -->
 <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1" />
     <meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" />
     <title>Apache Axis2 Web Administrator&apos;s Guide – Apache Axis2</title>
     <link rel="stylesheet" href="../css/apache-maven-fluido-2.0.0-M11.min.css" />
     <link rel="stylesheet" href="../css/site.css" />
     <link rel="stylesheet" href="../css/print.css" media="print" />
     <script src="../js/apache-maven-fluido-2.0.0-M11.min.js"></script>
 <meta name="generator" content="HTML Tidy for Windows (vers 14 June 2007), see www.w3.org" /><meta http-equiv="content-type" content="" />  </head>
   <body>
     <div class="container-fluid container-fluid-top">
       <header>
         <div id="banner">
           <div class="pull-left"><div id="bannerLeft"><h1><a href="http://www.apache.org/"><img class="class java.lang.Object" src="http://www.apache.org/images/asf_logo_wide.png" /> Apache Axis2</a></h1></div></div>
           <div class="pull-right"><div id="bannerRight"><h1><a href=".././"><img class="class java.lang.Object" src="../images/axis.jpg" /></a></h1></div></div>
           <div class="clear"><hr/></div>
         </div>

         <div id="breadcrumbs">
           <ul class="breadcrumb">
         <li id="publishDate">Last Published: 2025-03-04<span class="divider">|</span>
 </li>
           <li id="projectVersion">Version: 2.0.0<span class="divider">|</span></li>
       <li><a href="http://www.apache.org" class="externalLink">Apache</a><span class="divider">/</span></li>
       <li><a href="../index.html">Axis2/Java</a><span class="divider">/</span></li>
     <li class="active">Apache Axis2 Web Administrator&apos;s Guide</li>
           </ul>
         </div>
       </header>
       <div class="row-fluid">
         <header id="leftColumn" class="span2">
           <nav class="well sidebar-nav">
   <ul class="nav nav-list">
    <li class="nav-header">Axis2/Java</li>
     <li><a href="../index.html">Home</a></li>
     <li><a href="../download.html">Downloads</a></li>
     <li><a href="javascript:void(0)"><span class="icon-chevron-down"></span>Release Notes</a>
      <ul class="nav nav-list">
       <li><a href="../release-notes/1.6.1.html">1.6.1</a></li>
       <li><a href="../release-notes/1.6.2.html">1.6.2</a></li>
       <li><a href="../release-notes/1.6.3.html">1.6.3</a></li>
       <li><a href="../release-notes/1.6.4.html">1.6.4</a></li>
       <li><a href="../release-notes/1.7.0.html">1.7.0</a></li>
       <li><a href="../release-notes/1.7.1.html">1.7.1</a></li>
       <li><a href="../release-notes/1.7.2.html">1.7.2</a></li>
       <li><a href="../release-notes/1.7.3.html">1.7.3</a></li>
       <li><a href="../release-notes/1.7.4.html">1.7.4</a></li>
       <li><a href="../release-notes/1.7.5.html">1.7.5</a></li>
       <li><a href="../release-notes/1.7.6.html">1.7.6</a></li>
       <li><a href="../release-notes/1.7.7.html">1.7.7</a></li>
       <li><a href="../release-notes/1.7.8.html">1.7.8</a></li>
       <li><a href="../release-notes/1.7.9.html">1.7.9</a></li>
       <li><a href="../release-notes/1.8.0.html">1.8.0</a></li>
       <li><a href="../release-notes/1.8.1.html">1.8.1</a></li>
       <li><a href="../release-notes/1.8.2.html">1.8.2</a></li>
       <li><a href="../release-notes/2.0.0.html">2.0.0</a></li>
      </ul></li>
     <li><a href="../modules/index.html">Modules</a></li>
     <li><a href="../tools/index.html">Tools</a></li>
    <li class="nav-header">Documentation</li>
     <li><a href="../docs/toc.html">Table of Contents</a></li>
     <li><a href="../docs/installationguide.html">Installation Guide</a></li>
     <li><a href="../docs/quickstartguide.html">QuickStart Guide</a></li>
     <li><a href="../docs/userguide.html">User Guide</a></li>
     <li><a href="../docs/jaxws-guide.html">JAXWS Guide</a></li>
     <li><a href="../docs/pojoguide.html">POJO Guide</a></li>
     <li><a href="../docs/spring.html">Spring Guide</a></li>
     <li class="active"><a>Web Administrator&apos;s Guide</a></li>
     <li><a href="../docs/migration.html">Migration Guide (from Axis1)</a></li>
    <li class="nav-header">Resources</li>
     <li><a href="../faq.html">FAQ</a></li>
     <li><a href="../articles.html">Articles</a></li>
     <li><a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink">Wiki</a></li>
     <li><a href="../refLib.html">Reference Library</a></li>
     <li><a href="../apidocs/index.html">Online Java Docs</a></li>
    <li class="nav-header">Get Involved</li>
     <li><a href="../overview.html">Overview</a></li>
     <li><a href="../git.html">Checkout the Source</a></li>
     <li><a href="../mail-lists.html">Mailing Lists</a></li>
     <li><a href="../release-process.html">Release Process</a></li>
     <li><a href="../guidelines.html">Developer Guidelines</a></li>
     <li><a href="../siteHowTo.html">Build the Site</a></li>
    <li class="nav-header">Project Information</li>
     <li><a href="../team-list.html">Project Team</a></li>
     <li><a href="../issue-tracking.html">Issue Tracking</a></li>
     <li><a href="https://github.com/apache/axis-axis2-java-core" class="externalLink">Source Code</a></li>
     <li><a href="../thanks.html">Acknowledgements</a></li>
    <li class="nav-header">Apache</li>
     <li><a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink">License</a></li>
     <li><a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsorship</a></li>
     <li><a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a></li>
     <li><a href="http://www.apache.org/security/" class="externalLink">Security</a></li>
   </ul>
           </nav>
           <div class="well sidebar-nav">
             <div id="poweredBy">
               <div class="clear"></div>
               <div class="clear"></div>
 <a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a>
             </div>
           </div>
         </header>
         <main id="bodyColumn" class="span10">
 <html xmlns="http://www.w3.org/1999/xhtml">

 <section><a id="Apache_Axis2_Web_Administrator.27s_Guide"></a>
 <h1>Apache Axis2 Web Administrator's Guide</h1>

 <p>This document gives you detailed information on the
 administration console of the Apache Axis2 Web application. Apache
 Axis2 Administration is all about configuring Apache Axis2 at run
 time, where the configuration is transient.</p>

 <p><i>Send your feedback to: <a href="mailto:java-dev@axis.apache.org?subject=[Axis2]" class="externalLink">java-dev@axis.apache.org</a></i>.
 (Subscription details are available on the <a href="../mail-lists.html">Axis2 site</a>.)
 Kindly prefix every email subject with [Axis2].</p>
 <section><a id="Contents"></a>
 <h2>Contents</h2>

 <ul>

 <li><a href="#Intro">Introduction</a>

 <ul>

 <li>

 <p><a href="#login">Login into Administration Site</a></p>
 </li>
 </ul>
 </li>

 <li><a href="#adminoptions">Administration Options</a>

 <ul>

 <li>

 <p><a href="#tools">Tools</a></p>

 <ul>

 <li><a href="#upservice">Upload Service</a></li>
 </ul>
 </li>

 <li>

 <p><a href="#syscomponents">System components</a></p>

 <ul>

 <li><a href="#heading1">Available services</a></li>

 <li><a href="#servgroups">Available service groups</a></li>

 <li><a href="#avmodules">Available modules</a></li>

 <li><a href="#globalmodules">Globally engaged modules</a></li>

 <li><a href="#phases">Available phases</a></li>
 </ul>
 </li>

 <li>

 <p><a href="#executionchains">Execution chains</a></p>

 <ul>

 <li><a href="#globalchains">Global chains</a></li>

 <li><a href="#operationchains">Operation specific chains</a></li>
 </ul>
 </li>

 <li>

 <p><a href="#engaginmodule">Engage module</a></p>
 </li>

 <li><a href="#services">Services</a>

 <ul>

 <li><a href="#turnoffservice">Deactivate Service</a></li>

 <li><a href="#turnonservice">Activate Service</a></li>

 <li><a href="#editservicepara">Edit service parameters</a></li>
 </ul>
 </li>

 <li>

 <p><a href="#context">Contexts</a></p>

 <ul>

 <li><a href="#viewhierarchy">View Hierarchy</a></li>
 </ul>
 </li>
 </ul>
 </li>
 </ul>
 <a id="Intro"></a>
 <section><a id="Introduction"></a>
 <h3>Introduction</h3>

 <p>The Apache Axis2 Web application has three main sections:
 'Services' lists all the available services deployed in this
 server, 'Validate' checks the system to see whether all the
 required libraries are in place and views the system information,
 and 'Administration' is the Axis2 Web Administration module which
 is the console for administering the Apache Axis2 installation.</p>

 <p>The Axis2 Web Administration module provides a way to configure
 Axis2 dynamically. It's important to note that this dynamic
 configuration will NOT be persistent, i.e., if the servlet
 container is restarted, then all the dynamic configuration changes
 will be lost.</p>
 <a id="login"></a>
 <section><a id="Log_on_to_the_Administration_Site_.28DISABLED_BY_DEFAULT.29"></a>
 <h4>Log on to the Administration Site (DISABLED BY DEFAULT)</h4>

 <p>Once Apache Axis2 is successfully installed, the Web application
 can be accessed (see <a href="installationguide.html">Installation
 Guide</a> for instructions). From the <a href="#homepage">Axis2 Web
 Application Home page</a> you can go to the Administration page by
 clicking the 'Administration' link. The Login page shown below will
 appear requesting the user name and password. The default user name
 and password are undefined by default as the values are blank
 in the axis2.xml file. You must edit the axis2.xml to enable a login
 by defining a username and password. Below is an arbitrary example.
 The username is 'admin' (without quotes) and the password is 'axis2'
 (without quotes).</p>

 <p><img src="images/adminlogin.jpg" alt="" /></p>

 <p>You can change the user name and password values by changing the
 following two parameters in the axis2.xml as required.</p>

 <p><img src="images/parameters.jpg" alt="" /></p>

 <p>If the log on is successful, you will see the screen below. This
 is where you can view the configuration and the status of the
 running system and dynamically configure it.</p>

 <p><img src="images/admin.jpg" alt="" /></p>
 <a id="adminoptions"></a>
 </section></section><section><a id="Administration_Options"></a>
 <h3>Administration Options</h3>

 <div style="margin-left: 2em"><a id="tools"><b>Tools</b></a>

 <ul>

 <li><a href="#upservice">Upload Service</a></li>
 </ul>
 <a id="syscomponents"><b>System
 components</b></a>

 <ul>

 <li><a href="#heading1">Available services</a></li>

 <li><a href="#servgroups">Available service groups</a></li>

 <li><a href="#avmodules">Available modules</a></li>

 <li><a href="#globalmodules">Globally engaged modules</a></li>

 <li><a href="#phases">Available phases</a></li>
 </ul>
 <a id="executionchains"><b>Execution
 chains</b></a>

 <ul>

 <li><a href="#globalchains">Global chains</a></li>

 <li><a href="#operationchains">Operation specific chains</a></li>
 </ul>
 <b><a href="#engaginmodule">Engage module</a></b><br />

 <ul>

 <li>For all Services</li>

 <li>For a Service Group</li>

 <li>For a Service</li>

 <li>For an Operation</li>
 </ul>
 <a id="services"><b>Services</b></a>

 <ul>

 <li><a href="#turnoffservice">Deactivate service</a></li>

 <li><a href="#turnonservice">Activate service</a></li>

 <li><a href="#editservicepara">Edit service parameters</a></li>
 </ul>
 <a id="context"><b>Contexts</b></a>

 <ul>

 <li><a href="#viewhierarchy">View Hierarchy</a></li>
 </ul>
 </div>
 <a id="homepage"></a>
 </section><section><a id="Apache_Axis2_Web_Application_Home_Page"></a>
 <h3>Apache Axis2 Web Application Home Page</h3>

 <p><strong><img src="images/clip_image006.jpg" alt="" /></strong></p>
 <a id="upservice"></a>
 </section><section><a id="Upload_Services"></a>
 <h3>Upload Services</h3>

 <p>You can upload packaged Apache Axis2 service archive files using
 this page. This can be done in two simple steps:</p>

 <ul>

 <li>Browse to the location and select the axisService archive file
 you wish to upload</li>

 <li>Then click Upload</li>
 </ul>

 <p><img src="images/clip_image010.jpg" alt="" /></p>
 <a id="heading1"></a>
 </section><section><a id="Available_Services"></a>
 <h3>Available Services</h3>

 <p>The functionality of the 'Available Services' option is almost
 the same as the functionality of the 'Services' option on the Axis2
 Web Application Home page, where it displays a list of deployed
 services and their operations. As an additional feature, the
 'Available Services' page lists details of modules that are engaged
 to the deployed services and their operations on a global, service
 or on an operation level.</p>

 <p>Using the 'Disengage' link, you can disengage the corresponding
 module as long as the module is not globally engaged (i.e., engaged
 to all the services and operations).</p>

 <p>Click on a specific service and it will give you the WSDL file
 of that particular service.</p>

 <p><strong>Faulty services</strong> of this system will also be
 listed on this page. Click on a faulty service to view a page that
 lists the exception stack trace of the exception, which caused the
 service to be faulty.</p>

 <p><img src="images/adminmain.jpg" alt="" /></p>
 <a id="servgroups"></a>
 </section><section><a id="Available_Service_Groups"></a>
 <h3>Available Service Groups</h3>

 <p>Service group is a logical collection of related services, and
 the 'Available Service Groups' link will list all the available
 service groups in the system.</p>

 <p><img src="images/servicegroups.jpg" alt="" /></p>
 <a id="avmodules"></a>
 </section><section><a id="Available_Modules"></a>
 <h3>Available Modules</h3>

 <p>To view the available modules in the 'modules' directory of the
 repository, click 'Available Modules'. This will show you all the
 available modules in the system. Those modules can be engaged
 dynamically.</p>

 <p><img src="images/modules.jpg" alt="" /></p>
 <br />
 <a id="globalmodules"></a>
 </section><section><a id="Globally_Engaged_Modules"></a>
 <h3>Globally Engaged Modules</h3>

 <p>Click the 'Globally Engaged Modules' to view the globally
 engaged modules, if any. If a module is engaged globally, then the
 handlers that belong to that module will be executed irrespective
 of the service.</p>
 <a id="phases"></a>
 </section><section><a id="Available_Phases"></a>
 <h3>Available Phases</h3>

 <p>The 'Available Phases' link will display all the available
 phases. In Axis2, there are two levels of phases:</p>

 <ul>

 <li>System predefined phases (not allowed to be changed)</li>

 <li>User defined phases</li>
 </ul>

 <p>The main difference between these two levels is that system
 predefined phases will be invoked irrespective of the services,
 while the user defined phases will be invoked when the dispatcher
 finds the operation. Note that it is essential for module
 developers and service writers to have a good understanding of
 phases and phase ordering.</p>

 <p><img src="images/viewphases.jpg" alt="" /></p>
 <br />
 <a id="globalchains"></a>
 </section><section><a id="Global_Chains"></a>
 <h3>Global Chains</h3>

 <p>The 'Global Chains' link will display all the Global Execution
 Chains. The most interesting feature of the Axis2 Web
 Administration Module is that it provides a very basic method of
 viewing the global phase list and handlers inside the phases
 depending on both the phase and handler orders. This kind of
 information is extremely useful in debugging the system, as there
 is no other way to list out handlers in the global chains. If you
 engage a new module, the new handlers will be added to the global
 chains and will be displayed on this page.</p>

 <p><img src="images/globalchain.jpg" alt="" /></p>
 <br />
 <a id="operationchains"></a>
 </section><section><a id="Operation_Specific_Chains"></a>
 <h3>Operation Specific Chains</h3>

 <p>The 'Operation Specific Chains' link can be used to view the
 handlers corresponding to a given service in the same order as it
 is in the real execution chain.</p>

 <p><img src="images/select_service_for_handler.jpg" alt="" /></p>
 <br />

 <p>Select the service of whose service handlers you wish to view
 from the list, and click 'View' to view the handlers. The page
 below shows the service handlers of the service
 <em>version</em></p>

 <p><img src="images/serviceHandlers.jpg" alt="" /></p>
 <br />
 <a id="engaginmodule"></a>
 </section><section><a id="Engaging_Modules"></a>
 <h3>Engaging Modules</h3>

 <p>The 'Engaging Modules' link allows you to engage modules either
 globally (to all services), to a service group, to a service, or to
 an operation depending on the module implementation. If the module
 was designed to engage the handlers globally, then the handlers in
 the module can be included in any phase in the system. It can be
 either a system predefined phase or a user defined phase.</p>

 <p>On the other hand, if the module was implemented in such a way
 that it is going to be deployed to a service or to an operation,
 then the module cannot be included in any of the <a href="#phases">System Predefined Phases</a>. Thus it can only be
 included in <a href="#phases">User Defined Phases</a>.</p>

 <p>Immediately after engaging the module, you can see the status of
 the engagement indicating whether it is engaged properly or
 not.</p>

 <p><img src="images/moduleengage.jpg" alt="" /></p>
 <a id="turnoffservice"></a>
 </section><section><a id="Deactivate_Service"></a>
 <h3>Deactivate Service</h3>

 <p>The 'Deactivate Service' link under the 'Services' list will
 lead to the page below. The Deactivate service functionality
 provides a way to remove unnecessary services from the running
 system, but the removal is transient--which means that if you
 restart the system, the service will be active.</p>

 <p>To deactivate a service, select a service from the list, select
 the 'Deactivate service' check box, and then click 'Deactivate'..
 The 'Clear' button will clear the 'Deactivate service' check
 box.</p>

 <p><img src="images/inactivate.jpg" alt="" /></p>
 <br />
 <a id="turnonservice"></a>
 </section><section><a id="Activate_Service"></a>
 <h3>Activate Service</h3>

 <p>The 'Activate Service' link under the 'Services' list will lead
 to the page below. The Activate service functionality provides a
 way to activate services while the system is running, but the
 activation is transient-- which means that if you restart the
 system, the service will be inactive.</p>

 <p>To activate a service, select a service from the list, select
 the 'Activate Service' check box, then click 'Activate'. The
 'Clear' button will clear the 'Activate service' check box.</p>

 <p><img src="images/activate.jpg" alt="" /></p>
 <br />
 <a id="editservicepara"></a>
 </section><section><a id="Edit_Service_Parameters"></a>
 <h3>Edit Service Parameters</h3>

 <p>This functionality provides a way to change the parameters in a
 service or its operations. These changes will be transient too,
 which means if you restart the system, the changes will not be
 reflected.</p>

 <p>The 'Edit Parameters' link under the 'Services' list (on the
 navigation bar) will link to the page where you can select the
 services of which you want to edit the parameters. Once the service
 is selected, click 'Edit Parameters'.. This will open the page
 shown below.</p>

 <p><img src="images/editserviecpara.jpg" alt="" /></p>
 <br />
 <a id="viewhierarchy"></a>
 </section><section><a id="View_Hierarchy"></a>
 <h3>View Hierarchy</h3>

 <p>By listing the current context hierarchy, the 'View Hierarchy'
 link provides a means to look at the system state at run time. This
 will list out all the available service group contexts, service
 contexts, operation contexts, etc.</p>
 </section></section>
 </html>        </main>
       </div>
     </div>
     <hr/>
     <footer>
       <div class="container-fluid">
         <div class="row-fluid">
             <p>©      2004–2025
 <a href="https://www.apache.org/">The Apache Software Foundation</a>
 </p>
         </div>
       </div>
     </footer>
   </body>
 </html>
	<!DOCTYPE html>


	<!--
	\| Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/xdoc/docs/webadminguide.xml at 2025-03-05
	\| Rendered using Apache Maven Fluido Skin 2.0.0-M11
	-->
	<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
	<head>
	<meta charset="UTF-8" />
	<meta name="viewport" content="width=device-width, initial-scale=1" />
	<meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0" />
	<title>Apache Axis2 Web Administrator's Guide – Apache Axis2</title>
	<link rel="stylesheet" href="../css/apache-maven-fluido-2.0.0-M11.min.css" />
	<link rel="stylesheet" href="../css/site.css" />
	<link rel="stylesheet" href="../css/print.css" media="print" />
	<script src="../js/apache-maven-fluido-2.0.0-M11.min.js"></script>
	<meta name="generator" content="HTML Tidy for Windows (vers 14 June 2007), see www.w3.org" /><meta http-equiv="content-type" content="" /> </head>
	<body>
	<div class="container-fluid container-fluid-top">
	<header>
	<div id="banner">
	<div class="pull-left"><div id="bannerLeft"><h1><a href="http://www.apache.org/"><img class="class java.lang.Object" src="http://www.apache.org/images/asf_logo_wide.png" /> Apache Axis2</a></h1></div></div>
	<div class="pull-right"><div id="bannerRight"><h1><a href=".././"><img class="class java.lang.Object" src="../images/axis.jpg" /></a></h1></div></div>
	<div class="clear"><hr/></div>
	</div>

	<div id="breadcrumbs">
	<ul class="breadcrumb">
	<li id="publishDate">Last Published: 2025-03-04<span class="divider">\|</span>
	</li>
	<li id="projectVersion">Version: 2.0.0<span class="divider">\|</span></li>
	<li><a href="http://www.apache.org" class="externalLink">Apache</a><span class="divider">/</span></li>
	<li><a href="../index.html">Axis2/Java</a><span class="divider">/</span></li>
	<li class="active">Apache Axis2 Web Administrator's Guide</li>
	</ul>
	</div>
	</header>
	<div class="row-fluid">
	<header id="leftColumn" class="span2">
	<nav class="well sidebar-nav">
	<ul class="nav nav-list">
	<li class="nav-header">Axis2/Java</li>
	<li><a href="../index.html">Home</a></li>
	<li><a href="../download.html">Downloads</a></li>
	<li><a href="javascript:void(0)"><span class="icon-chevron-down"></span>Release Notes</a>
	<ul class="nav nav-list">
	<li><a href="../release-notes/1.6.1.html">1.6.1</a></li>
	<li><a href="../release-notes/1.6.2.html">1.6.2</a></li>
	<li><a href="../release-notes/1.6.3.html">1.6.3</a></li>
	<li><a href="../release-notes/1.6.4.html">1.6.4</a></li>
	<li><a href="../release-notes/1.7.0.html">1.7.0</a></li>
	<li><a href="../release-notes/1.7.1.html">1.7.1</a></li>
	<li><a href="../release-notes/1.7.2.html">1.7.2</a></li>
	<li><a href="../release-notes/1.7.3.html">1.7.3</a></li>
	<li><a href="../release-notes/1.7.4.html">1.7.4</a></li>
	<li><a href="../release-notes/1.7.5.html">1.7.5</a></li>
	<li><a href="../release-notes/1.7.6.html">1.7.6</a></li>
	<li><a href="../release-notes/1.7.7.html">1.7.7</a></li>
	<li><a href="../release-notes/1.7.8.html">1.7.8</a></li>
	<li><a href="../release-notes/1.7.9.html">1.7.9</a></li>
	<li><a href="../release-notes/1.8.0.html">1.8.0</a></li>
	<li><a href="../release-notes/1.8.1.html">1.8.1</a></li>
	<li><a href="../release-notes/1.8.2.html">1.8.2</a></li>
	<li><a href="../release-notes/2.0.0.html">2.0.0</a></li>
	</ul></li>
	<li><a href="../modules/index.html">Modules</a></li>
	<li><a href="../tools/index.html">Tools</a></li>
	<li class="nav-header">Documentation</li>
	<li><a href="../docs/toc.html">Table of Contents</a></li>
	<li><a href="../docs/installationguide.html">Installation Guide</a></li>
	<li><a href="../docs/quickstartguide.html">QuickStart Guide</a></li>
	<li><a href="../docs/userguide.html">User Guide</a></li>
	<li><a href="../docs/jaxws-guide.html">JAXWS Guide</a></li>
	<li><a href="../docs/pojoguide.html">POJO Guide</a></li>
	<li><a href="../docs/spring.html">Spring Guide</a></li>
	<li class="active"><a>Web Administrator's Guide</a></li>
	<li><a href="../docs/migration.html">Migration Guide (from Axis1)</a></li>
	<li class="nav-header">Resources</li>
	<li><a href="../faq.html">FAQ</a></li>
	<li><a href="../articles.html">Articles</a></li>
	<li><a href="http://wiki.apache.org/ws/FrontPage/Axis2/" class="externalLink">Wiki</a></li>
	<li><a href="../refLib.html">Reference Library</a></li>
	<li><a href="../apidocs/index.html">Online Java Docs</a></li>
	<li class="nav-header">Get Involved</li>
	<li><a href="../overview.html">Overview</a></li>
	<li><a href="../git.html">Checkout the Source</a></li>
	<li><a href="../mail-lists.html">Mailing Lists</a></li>
	<li><a href="../release-process.html">Release Process</a></li>
	<li><a href="../guidelines.html">Developer Guidelines</a></li>
	<li><a href="../siteHowTo.html">Build the Site</a></li>
	<li class="nav-header">Project Information</li>
	<li><a href="../team-list.html">Project Team</a></li>
	<li><a href="../issue-tracking.html">Issue Tracking</a></li>
	<li><a href="https://github.com/apache/axis-axis2-java-core" class="externalLink">Source Code</a></li>
	<li><a href="../thanks.html">Acknowledgements</a></li>
	<li class="nav-header">Apache</li>
	<li><a href="http://www.apache.org/licenses/LICENSE-2.0.html" class="externalLink">License</a></li>
	<li><a href="http://www.apache.org/foundation/sponsorship.html" class="externalLink">Sponsorship</a></li>
	<li><a href="http://www.apache.org/foundation/thanks.html" class="externalLink">Thanks</a></li>
	<li><a href="http://www.apache.org/security/" class="externalLink">Security</a></li>
	</ul>
	</nav>
	<div class="well sidebar-nav">
	<div id="poweredBy">
	<div class="clear"></div>
	<div class="clear"></div>
	<a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="../images/logos/maven-feather.png" /></a>
	</div>
	</div>
	</header>
	<main id="bodyColumn" class="span10">
	<html xmlns="http://www.w3.org/1999/xhtml">

	<section><a id="Apache_Axis2_Web_Administrator.27s_Guide"></a>
	<h1>Apache Axis2 Web Administrator's Guide</h1>

	<p>This document gives you detailed information on the
	administration console of the Apache Axis2 Web application. Apache
	Axis2 Administration is all about configuring Apache Axis2 at run
	time, where the configuration is transient.</p>

	<p><i>Send your feedback to: <a href="mailto:java-dev@axis.apache.org?subject=[Axis2]" class="externalLink">java-dev@axis.apache.org</a></i>.
	(Subscription details are available on the <a href="../mail-lists.html">Axis2 site</a>.)
	Kindly prefix every email subject with [Axis2].</p>
	<section><a id="Contents"></a>
	<h2>Contents</h2>

	<ul>

	<li><a href="#Intro">Introduction</a>

	<ul>

	<li>

	<p><a href="#login">Login into Administration Site</a></p>
	</li>
	</ul>
	</li>

	<li><a href="#adminoptions">Administration Options</a>

	<ul>

	<li>

	<p><a href="#tools">Tools</a></p>

	<ul>

	<li><a href="#upservice">Upload Service</a></li>
	</ul>
	</li>

	<li>

	<p><a href="#syscomponents">System components</a></p>

	<ul>

	<li><a href="#heading1">Available services</a></li>

	<li><a href="#servgroups">Available service groups</a></li>

	<li><a href="#avmodules">Available modules</a></li>

	<li><a href="#globalmodules">Globally engaged modules</a></li>

	<li><a href="#phases">Available phases</a></li>
	</ul>
	</li>

	<li>

	<p><a href="#executionchains">Execution chains</a></p>

	<ul>

	<li><a href="#globalchains">Global chains</a></li>

	<li><a href="#operationchains">Operation specific chains</a></li>
	</ul>
	</li>

	<li>

	<p><a href="#engaginmodule">Engage module</a></p>
	</li>

	<li><a href="#services">Services</a>

	<ul>

	<li><a href="#turnoffservice">Deactivate Service</a></li>

	<li><a href="#turnonservice">Activate Service</a></li>

	<li><a href="#editservicepara">Edit service parameters</a></li>
	</ul>
	</li>

	<li>

	<p><a href="#context">Contexts</a></p>

	<ul>

	<li><a href="#viewhierarchy">View Hierarchy</a></li>
	</ul>
	</li>
	</ul>
	</li>
	</ul>
	<a id="Intro"></a>
	<section><a id="Introduction"></a>
	<h3>Introduction</h3>

	<p>The Apache Axis2 Web application has three main sections:
	'Services' lists all the available services deployed in this
	server, 'Validate' checks the system to see whether all the
	required libraries are in place and views the system information,
	and 'Administration' is the Axis2 Web Administration module which
	is the console for administering the Apache Axis2 installation.</p>

	<p>The Axis2 Web Administration module provides a way to configure
	Axis2 dynamically. It's important to note that this dynamic
	configuration will NOT be persistent, i.e., if the servlet
	container is restarted, then all the dynamic configuration changes
	will be lost.</p>
	<a id="login"></a>
	<section><a id="Log_on_to_the_Administration_Site_.28DISABLED_BY_DEFAULT.29"></a>
	<h4>Log on to the Administration Site (DISABLED BY DEFAULT)</h4>

	<p>Once Apache Axis2 is successfully installed, the Web application
	can be accessed (see <a href="installationguide.html">Installation
	Guide</a> for instructions). From the <a href="#homepage">Axis2 Web
	Application Home page</a> you can go to the Administration page by
	clicking the 'Administration' link. The Login page shown below will
	appear requesting the user name and password. The default user name
	and password are undefined by default as the values are blank
	in the axis2.xml file. You must edit the axis2.xml to enable a login
	by defining a username and password. Below is an arbitrary example.
	The username is 'admin' (without quotes) and the password is 'axis2'
	(without quotes).</p>

	<p><img src="images/adminlogin.jpg" alt="" /></p>

	<p>You can change the user name and password values by changing the
	following two parameters in the axis2.xml as required.</p>

	<p><img src="images/parameters.jpg" alt="" /></p>

	<p>If the log on is successful, you will see the screen below. This
	is where you can view the configuration and the status of the
	running system and dynamically configure it.</p>

	<p><img src="images/admin.jpg" alt="" /></p>
	<a id="adminoptions"></a>
	</section></section><section><a id="Administration_Options"></a>
	<h3>Administration Options</h3>

	<div style="margin-left: 2em"><a id="tools"><b>Tools</b></a>

	<ul>

	<li><a href="#upservice">Upload Service</a></li>
	</ul>
	<a id="syscomponents"><b>System
	components</b></a>

	<ul>

	<li><a href="#heading1">Available services</a></li>

	<li><a href="#servgroups">Available service groups</a></li>

	<li><a href="#avmodules">Available modules</a></li>

	<li><a href="#globalmodules">Globally engaged modules</a></li>

	<li><a href="#phases">Available phases</a></li>
	</ul>
	<a id="executionchains"><b>Execution
	chains</b></a>

	<ul>

	<li><a href="#globalchains">Global chains</a></li>

	<li><a href="#operationchains">Operation specific chains</a></li>
	</ul>
	<b><a href="#engaginmodule">Engage module</a></b><br />

	<ul>

	<li>For all Services</li>

	<li>For a Service Group</li>

	<li>For a Service</li>

	<li>For an Operation</li>
	</ul>
	<a id="services"><b>Services</b></a>

	<ul>

	<li><a href="#turnoffservice">Deactivate service</a></li>

	<li><a href="#turnonservice">Activate service</a></li>

	<li><a href="#editservicepara">Edit service parameters</a></li>
	</ul>
	<a id="context"><b>Contexts</b></a>

	<ul>

	<li><a href="#viewhierarchy">View Hierarchy</a></li>
	</ul>
	</div>
	<a id="homepage"></a>
	</section><section><a id="Apache_Axis2_Web_Application_Home_Page"></a>
	<h3>Apache Axis2 Web Application Home Page</h3>

	<p><strong><img src="images/clip_image006.jpg" alt="" /></strong></p>
	<a id="upservice"></a>
	</section><section><a id="Upload_Services"></a>
	<h3>Upload Services</h3>

	<p>You can upload packaged Apache Axis2 service archive files using
	this page. This can be done in two simple steps:</p>

	<ul>

	<li>Browse to the location and select the axisService archive file
	you wish to upload</li>

	<li>Then click Upload</li>
	</ul>

	<p><img src="images/clip_image010.jpg" alt="" /></p>
	<a id="heading1"></a>
	</section><section><a id="Available_Services"></a>
	<h3>Available Services</h3>

	<p>The functionality of the 'Available Services' option is almost
	the same as the functionality of the 'Services' option on the Axis2
	Web Application Home page, where it displays a list of deployed
	services and their operations. As an additional feature, the
	'Available Services' page lists details of modules that are engaged
	to the deployed services and their operations on a global, service
	or on an operation level.</p>

	<p>Using the 'Disengage' link, you can disengage the corresponding
	module as long as the module is not globally engaged (i.e., engaged
	to all the services and operations).</p>

	<p>Click on a specific service and it will give you the WSDL file
	of that particular service.</p>

	<p><strong>Faulty services</strong> of this system will also be
	listed on this page. Click on a faulty service to view a page that
	lists the exception stack trace of the exception, which caused the
	service to be faulty.</p>

	<p><img src="images/adminmain.jpg" alt="" /></p>
	<a id="servgroups"></a>
	</section><section><a id="Available_Service_Groups"></a>
	<h3>Available Service Groups</h3>

	<p>Service group is a logical collection of related services, and
	the 'Available Service Groups' link will list all the available
	service groups in the system.</p>

	<p><img src="images/servicegroups.jpg" alt="" /></p>
	<a id="avmodules"></a>
	</section><section><a id="Available_Modules"></a>
	<h3>Available Modules</h3>

	<p>To view the available modules in the 'modules' directory of the
	repository, click 'Available Modules'. This will show you all the
	available modules in the system. Those modules can be engaged
	dynamically.</p>

	<p><img src="images/modules.jpg" alt="" /></p>
	<br />
	<a id="globalmodules"></a>
	</section><section><a id="Globally_Engaged_Modules"></a>
	<h3>Globally Engaged Modules</h3>

	<p>Click the 'Globally Engaged Modules' to view the globally
	engaged modules, if any. If a module is engaged globally, then the
	handlers that belong to that module will be executed irrespective
	of the service.</p>
	<a id="phases"></a>
	</section><section><a id="Available_Phases"></a>
	<h3>Available Phases</h3>

	<p>The 'Available Phases' link will display all the available
	phases. In Axis2, there are two levels of phases:</p>

	<ul>

	<li>System predefined phases (not allowed to be changed)</li>

	<li>User defined phases</li>
	</ul>

	<p>The main difference between these two levels is that system
	predefined phases will be invoked irrespective of the services,
	while the user defined phases will be invoked when the dispatcher
	finds the operation. Note that it is essential for module
	developers and service writers to have a good understanding of
	phases and phase ordering.</p>

	<p><img src="images/viewphases.jpg" alt="" /></p>
	<br />
	<a id="globalchains"></a>
	</section><section><a id="Global_Chains"></a>
	<h3>Global Chains</h3>

	<p>The 'Global Chains' link will display all the Global Execution
	Chains. The most interesting feature of the Axis2 Web
	Administration Module is that it provides a very basic method of
	viewing the global phase list and handlers inside the phases
	depending on both the phase and handler orders. This kind of
	information is extremely useful in debugging the system, as there
	is no other way to list out handlers in the global chains. If you
	engage a new module, the new handlers will be added to the global
	chains and will be displayed on this page.</p>

	<p><img src="images/globalchain.jpg" alt="" /></p>
	<br />
	<a id="operationchains"></a>
	</section><section><a id="Operation_Specific_Chains"></a>
	<h3>Operation Specific Chains</h3>

	<p>The 'Operation Specific Chains' link can be used to view the
	handlers corresponding to a given service in the same order as it
	is in the real execution chain.</p>

	<p><img src="images/select_service_for_handler.jpg" alt="" /></p>
	<br />

	<p>Select the service of whose service handlers you wish to view
	from the list, and click 'View' to view the handlers. The page
	below shows the service handlers of the service
	<em>version</em></p>

	<p><img src="images/serviceHandlers.jpg" alt="" /></p>
	<br />
	<a id="engaginmodule"></a>
	</section><section><a id="Engaging_Modules"></a>
	<h3>Engaging Modules</h3>

	<p>The 'Engaging Modules' link allows you to engage modules either
	globally (to all services), to a service group, to a service, or to
	an operation depending on the module implementation. If the module
	was designed to engage the handlers globally, then the handlers in
	the module can be included in any phase in the system. It can be
	either a system predefined phase or a user defined phase.</p>

	<p>On the other hand, if the module was implemented in such a way
	that it is going to be deployed to a service or to an operation,
	then the module cannot be included in any of the <a href="#phases">System Predefined Phases</a>. Thus it can only be
	included in <a href="#phases">User Defined Phases</a>.</p>

	<p>Immediately after engaging the module, you can see the status of
	the engagement indicating whether it is engaged properly or
	not.</p>

	<p><img src="images/moduleengage.jpg" alt="" /></p>
	<a id="turnoffservice"></a>
	</section><section><a id="Deactivate_Service"></a>
	<h3>Deactivate Service</h3>

	<p>The 'Deactivate Service' link under the 'Services' list will
	lead to the page below. The Deactivate service functionality
	provides a way to remove unnecessary services from the running
	system, but the removal is transient--which means that if you
	restart the system, the service will be active.</p>

	<p>To deactivate a service, select a service from the list, select
	the 'Deactivate service' check box, and then click 'Deactivate'..
	The 'Clear' button will clear the 'Deactivate service' check
	box.</p>

	<p><img src="images/inactivate.jpg" alt="" /></p>
	<br />
	<a id="turnonservice"></a>
	</section><section><a id="Activate_Service"></a>
	<h3>Activate Service</h3>

	<p>The 'Activate Service' link under the 'Services' list will lead
	to the page below. The Activate service functionality provides a
	way to activate services while the system is running, but the
	activation is transient-- which means that if you restart the
	system, the service will be inactive.</p>

	<p>To activate a service, select a service from the list, select
	the 'Activate Service' check box, then click 'Activate'. The
	'Clear' button will clear the 'Activate service' check box.</p>

	<p><img src="images/activate.jpg" alt="" /></p>
	<br />
	<a id="editservicepara"></a>
	</section><section><a id="Edit_Service_Parameters"></a>
	<h3>Edit Service Parameters</h3>

	<p>This functionality provides a way to change the parameters in a
	service or its operations. These changes will be transient too,
	which means if you restart the system, the changes will not be
	reflected.</p>

	<p>The 'Edit Parameters' link under the 'Services' list (on the
	navigation bar) will link to the page where you can select the
	services of which you want to edit the parameters. Once the service
	is selected, click 'Edit Parameters'.. This will open the page
	shown below.</p>

	<p><img src="images/editserviecpara.jpg" alt="" /></p>
	<br />
	<a id="viewhierarchy"></a>
	</section><section><a id="View_Hierarchy"></a>
	<h3>View Hierarchy</h3>

	<p>By listing the current context hierarchy, the 'View Hierarchy'
	link provides a means to look at the system state at run time. This
	will list out all the available service group contexts, service
	contexts, operation contexts, etc.</p>
	</section></section>
	</html> </main>
	</div>
	</div>
	<hr/>
	<footer>
	<div class="container-fluid">
	<div class="row-fluid">
	<p>© 2004–2025
	<a href="https://www.apache.org/">The Apache Software Foundation</a>
	</p>
	</div>
	</div>
	</footer>
	</body>
	</html>