org.apache.axis.utils
Class Admin

java.lang.Object
  |
  +--org.apache.axis.utils.Admin

public class Admin
extends java.lang.Object

Handy static utility functions for turning XML into Axis deployment operations.

Author:
Doug Davis (dug@us.ibm.com), Glen Daniels (gdaniels@macromedia.com)

Constructor Summary
Admin()
           
 
Method Summary
 org.w3c.dom.Document AdminService(MessageContext msgContext, org.w3c.dom.Document xml)
          Process a given XML document - needs cleanup.
static org.w3c.dom.Element list(org.w3c.dom.Element root, HandlerRegistry registry)
          Return an XML Element containing the configuration info for one of the engine's Handler registries.
static org.w3c.dom.Document listConfig(AxisEngine engine)
          Get an XML document representing this engine's configuration.
static void main(java.lang.String[] args)
           
 org.w3c.dom.Document process(MessageContext msgContext, org.w3c.dom.Element root)
          The meat of the Admin service.
static void processEngineConfig(org.w3c.dom.Document doc, AxisEngine engine)
          Process an engine configuration file by deploying appropriate stuff into the specified AxisEngine, and then telling it to save itself when we're done.
static void registerChain(org.w3c.dom.Element elem, AxisEngine engine)
          Deploy a chain described in XML into an AxisEngine.
static void registerHandler(org.w3c.dom.Element elem, AxisEngine engine)
          Deploy a handler described in XML into an AxisEngine.
static void registerService(org.w3c.dom.Element elem, AxisEngine engine)
          Deploy a service described in XML into an AxisEngine.
static void registerTransport(org.w3c.dom.Element elem, AxisEngine engine)
          Deploy a transport described in XML into an AxisEngine.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Admin

public Admin()
Method Detail

AdminService

public org.w3c.dom.Document AdminService(MessageContext msgContext,
                                         org.w3c.dom.Document xml)
                                  throws AxisFault
Process a given XML document - needs cleanup.

processEngineConfig

public static void processEngineConfig(org.w3c.dom.Document doc,
                                       AxisEngine engine)
                                throws java.lang.Exception
Process an engine configuration file by deploying appropriate stuff into the specified AxisEngine, and then telling it to save itself when we're done.
Parameters:
doc - an XML document containing an Axis engine configuration
engine - the AxisEngine in which to deploy
Throws:
java.lang.Exception - (should be DeploymentException?)

process

public org.w3c.dom.Document process(MessageContext msgContext,
                                    org.w3c.dom.Element root)
                             throws AxisFault
The meat of the Admin service. Process an xML document rooted with a "deploy", "undeploy", "list", or "quit" element.
Parameters:
msgContext - the MessageContext we're processing
root - the root Element of the XML
Returns:
an XML Document indicating the results.

listConfig

public static org.w3c.dom.Document listConfig(AxisEngine engine)
                                       throws AxisFault
Get an XML document representing this engine's configuration. This document is suitable for saving and reloading into the engine.
Parameters:
engine - the AxisEngine to work with
Returns:
an XML document holding the engine config
Throws:
AxisFault -  

list

public static org.w3c.dom.Element list(org.w3c.dom.Element root,
                                       HandlerRegistry registry)
                                throws AxisFault
Return an XML Element containing the configuration info for one of the engine's Handler registries.
Parameters:
root - the Element to work with (same as the one we return)
registry - the registry to write into this Element
Returns:
Element our config element, suitable for pumping back through Admin processing later, to redeploy.

registerChain

public static void registerChain(org.w3c.dom.Element elem,
                                 AxisEngine engine)
                          throws AxisFault
Deploy a chain described in XML into an AxisEngine.
Parameters:
elem - the element
engine - the AxisEngine in which to deploy

registerService

public static void registerService(org.w3c.dom.Element elem,
                                   AxisEngine engine)
                            throws AxisFault
Deploy a service described in XML into an AxisEngine.
Parameters:
elem - the element
engine - the AxisEngine in which to deploy

registerHandler

public static void registerHandler(org.w3c.dom.Element elem,
                                   AxisEngine engine)
                            throws AxisFault
Deploy a handler described in XML into an AxisEngine.
Parameters:
elem - the element
engine - the AxisEngine in which to deploy

registerTransport

public static void registerTransport(org.w3c.dom.Element elem,
                                     AxisEngine engine)
                              throws AxisFault
Deploy a transport described in XML into an AxisEngine.
Parameters:
elem - the element
engine - the AxisEngine in which to deploy

main

public static void main(java.lang.String[] args)
                 throws java.lang.Exception


Copyright © 2001 Apache XML Project. All Rights Reserved.