org.apache.axis.handlers.soap
Class SOAPService

java.lang.Object
  |
  +--org.apache.axis.handlers.BasicHandler
        |
        +--org.apache.axis.SimpleTargetedChain
              |
              +--org.apache.axis.handlers.soap.SOAPService
All Implemented Interfaces:
Handler, java.io.Serializable, TargetedChain

public class SOAPService
extends SimpleTargetedChain

A SOAPService is a Handler which encapsulates a SOAP invocation. It has an request chain, an response chain, and a pivot-point, and handles the SOAP semantics when invoke()d.

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

Fields inherited from class org.apache.axis.SimpleTargetedChain
pivotHandler, requestHandler, responseHandler
 
Fields inherited from class org.apache.axis.handlers.BasicHandler
name, options
 
Constructor Summary
SOAPService()
          Standard, no-arg constructor.
SOAPService(Handler serviceHandler)
          Convenience constructor for wrapping SOAP semantics around "service handlers" which actually do work.
 
Method Summary
 boolean availableFromTransport(java.lang.String transportName)
           
 void disableTransport(java.lang.String transportName)
          Disable access to this service from a particular transport
 void enableTransport(java.lang.String transportName)
          Make this service available on a particular transport
 org.w3c.dom.Element getDeploymentData(org.w3c.dom.Document doc)
          This will return the root element of an XML doc that describes the deployment information about this handler.
 ServiceDescription getServiceDescription()
           
 TypeMappingRegistry getTypeMappingRegistry()
           
 void invoke(MessageContext msgContext)
          Invoke the request chain, pivot handler and response chain.
 void registerTypeMapping(QName qName, java.lang.Class cls, DeserializerFactory deserFactory, Serializer serializer)
          Register a new service type mapping
 void setEngine(AxisEngine engine)
          Tell this service which engine it's deployed to.
 void setServiceDescription(ServiceDescription sd)
           
 void setTypeMappingRegistry(TypeMappingRegistry map)
           
 void start()
          Placeholder for "enable this service" method
 void stop()
          Placeholder for "disable this service" method
 void undo(MessageContext msgContext)
          Undo all of the work - in reverse order.
 void unregisterTypeMapping(QName qName, java.lang.Class cls)
          Unregister a service type mapping
 
Methods inherited from class org.apache.axis.SimpleTargetedChain
canHandleBlock, cleanup, clear, fillInDeploymentData, generateWSDL, getPivotHandler, getRequestHandler, getResponseHandler, init, setPivotHandler, setRequestHandler, setResponseHandler
 
Methods inherited from class org.apache.axis.handlers.BasicHandler
addOption, getName, getOption, getOptions, setName, setOptions
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.axis.Handler
addOption, getName, getOption, getOptions, setName, setOptions
 

Constructor Detail

SOAPService

public SOAPService()
Standard, no-arg constructor.

SOAPService

public SOAPService(Handler serviceHandler)
Convenience constructor for wrapping SOAP semantics around "service handlers" which actually do work.
Method Detail

getTypeMappingRegistry

public TypeMappingRegistry getTypeMappingRegistry()

setTypeMappingRegistry

public void setTypeMappingRegistry(TypeMappingRegistry map)

getServiceDescription

public ServiceDescription getServiceDescription()

setServiceDescription

public void setServiceDescription(ServiceDescription sd)

setEngine

public void setEngine(AxisEngine engine)
Tell this service which engine it's deployed to. The main result of this right now is to set up type mapping relationships.

availableFromTransport

public boolean availableFromTransport(java.lang.String transportName)

invoke

public void invoke(MessageContext msgContext)
            throws AxisFault
Description copied from class: SimpleTargetedChain
Invoke the request chain, pivot handler and response chain. If there's a fault we need to make sure that we undo any completed handler that has been successfully invoked and then rethrow the fault.
Overrides:
invoke in class SimpleTargetedChain

undo

public void undo(MessageContext msgContext)
Description copied from class: SimpleTargetedChain
Undo all of the work - in reverse order.
Overrides:
undo in class SimpleTargetedChain

getDeploymentData

public org.w3c.dom.Element getDeploymentData(org.w3c.dom.Document doc)
Description copied from interface: Handler
This will return the root element of an XML doc that describes the deployment information about this handler. This is NOT the WSDL, this is all of the static internal data use by Axis - WSDL takes into account run-time information (like which service we're talking about) this is just the data that's stored in the registry. Used by the 'list' Admin function.
Overrides:
getDeploymentData in class SimpleTargetedChain

start

public void start()
Placeholder for "enable this service" method

stop

public void stop()
Placeholder for "disable this service" method

registerTypeMapping

public void registerTypeMapping(QName qName,
                                java.lang.Class cls,
                                DeserializerFactory deserFactory,
                                Serializer serializer)
Register a new service type mapping

unregisterTypeMapping

public void unregisterTypeMapping(QName qName,
                                  java.lang.Class cls)
Unregister a service type mapping

enableTransport

public void enableTransport(java.lang.String transportName)
Make this service available on a particular transport

disableTransport

public void disableTransport(java.lang.String transportName)
Disable access to this service from a particular transport


Copyright © 2001 Apache XML Project. All Rights Reserved.