org.jboss.axis.handlers.soap
Class SOAPService

java.lang.Object
  extended byorg.jboss.axis.handlers.BasicHandler (src) 
      extended byorg.jboss.axis.SimpleChain (src) 
          extended byorg.jboss.axis.SimpleTargetedChain (src) 
              extended byorg.jboss.axis.handlers.soap.SOAPService
All Implemented Interfaces:
Chain (src) , Handler (src) , TargetedChain (src)

public class SOAPService
extends SimpleTargetedChain (src)

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.


Field Summary
 
Fields inherited from class org.jboss.axis.SimpleTargetedChain (src)
pivotHandler, requestHandler, responseHandler
 
Fields inherited from class org.jboss.axis.SimpleChain (src)
handlers, invoked
 
Fields inherited from class org.jboss.axis.handlers.BasicHandler (src)
makeLockable, name, options
 
Constructor Summary
SOAPService()
          Standard, no-arg constructor.
SOAPService(Handler (src)  serviceHandler)
          Convenience constructor for wrapping SOAP semantics around "service handlers" which actually do work.
SOAPService(Handler (src)  reqHandler, Handler (src)  pivHandler, Handler (src)  respHandler)
          Constructor with real or null request, pivot, and response handlers.
 
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
 void generateWSDL(MessageContext (src)  msgContext)
          Generate WSDL.
 java.util.ArrayList getActors()
          Get the merged actor list for this service, including engine-wide actor URIs.
 AxisEngine (src) getEngine()
           
 ServiceDesc (src) getInitializedServiceDesc(MessageContext (src)  msgContext)
          Returns a service description with the implementation class filled in.
 int getSendType()
           
 java.util.ArrayList getServiceActors()
          Get the service-specific actor list
 ServiceDesc (src) getServiceDescription()
           
 Style (src) getStyle()
           
 TypeMappingRegistry (src) getTypeMappingRegistry()
           
 Use (src) getUse()
           
 void invoke(MessageContext (src)  msgContext)
          Invoke is called to do the actual work of the Handler object.
 boolean needsHighFidelityRecording()
           
 void setEngine(AxisEngine (src)  engine)
          Tell this service which engine it's deployed to.
 void setHighFidelityRecording(boolean highFidelityRecording)
           
 void setPropertyParent(java.util.Hashtable parent)
           
 void setSendType(int sendType)
           
 void setServiceDescription(ServiceDesc (src)  serviceDescription)
           
 void setStyle(Style (src)  style)
           
 void setUse(Use (src)  style)
           
 void start()
          Placeholder for "enable this service" method
 void stop()
          Placeholder for "disable this service" method
 
Methods inherited from class org.jboss.axis.SimpleTargetedChain (src)
getPivotHandler, getRequestHandler, getResponseHandler, init
 
Methods inherited from class org.jboss.axis.SimpleChain (src)
addHandler, canHandleBlock, cleanup, contains, getDeploymentData, getHandlers, init, onFault
 
Methods inherited from class org.jboss.axis.handlers.BasicHandler (src)
getName, getOption, getOptions, getUnderstoodHeaders, initHashtable, setName, setOption, setOptionDefault, setOptions, setOptionsLockable
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.jboss.axis.Chain (src)
addHandler, contains, getHandlers
 
Methods inherited from interface org.jboss.axis.Handler (src)
canHandleBlock, cleanup, getDeploymentData, getName, getOption, getOptions, getUnderstoodHeaders, init, onFault, setName, setOption, setOptions
 

Constructor Detail

SOAPService

public SOAPService()
Standard, no-arg constructor.


SOAPService

public SOAPService(Handler (src)  reqHandler,
                   Handler (src)  pivHandler,
                   Handler (src)  respHandler)
Constructor with real or null request, pivot, and response handlers. A special request handler is specified to inject SOAP semantics.


SOAPService

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

Method Detail

getServiceActors

public java.util.ArrayList getServiceActors()
Get the service-specific actor list

Returns:

getActors

public java.util.ArrayList getActors()
Get the merged actor list for this service, including engine-wide actor URIs.

Returns:

getTypeMappingRegistry

public TypeMappingRegistry (src)  getTypeMappingRegistry()

setEngine

public void setEngine(AxisEngine (src)  engine)
Tell this service which engine it's deployed to.


getEngine

public AxisEngine (src)  getEngine()

availableFromTransport

public boolean availableFromTransport(java.lang.String transportName)

getStyle

public Style (src)  getStyle()

setStyle

public void setStyle(Style (src)  style)

getUse

public Use (src)  getUse()

setUse

public void setUse(Use (src)  style)

getServiceDescription

public ServiceDesc (src)  getServiceDescription()

getInitializedServiceDesc

public ServiceDesc (src)  getInitializedServiceDesc(MessageContext (src)  msgContext)
                                      throws AxisFault (src) 
Returns a service description with the implementation class filled in. Syncronized to prevent simutaneous modification of serviceDescription.

Throws:
AxisFault (src)

setServiceDescription

public void setServiceDescription(ServiceDesc (src)  serviceDescription)

setPropertyParent

public void setPropertyParent(java.util.Hashtable parent)

generateWSDL

public void generateWSDL(MessageContext (src)  msgContext)
                  throws AxisFault (src) 
Generate WSDL. If we have a specific file configured in the ServiceDesc, just return that. Otherwise run through all the Handlers (including the provider) and call generateWSDL() on them via our parent's implementation.

Specified by:
generateWSDL in interface Handler (src)
Overrides:
generateWSDL in class SimpleChain (src)
Throws:
AxisFault (src)

start

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


stop

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


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


needsHighFidelityRecording

public boolean needsHighFidelityRecording()

setHighFidelityRecording

public void setHighFidelityRecording(boolean highFidelityRecording)

getSendType

public int getSendType()

setSendType

public void setSendType(int sendType)

invoke

public void invoke(MessageContext (src)  msgContext)
            throws AxisFault (src) 
Description copied from interface: Handler (src)
Invoke is called to do the actual work of the Handler object. If there is a fault during the processing of this method it is invoke's job to catch the exception and undo any partial work that has been completed. Once we leave 'invoke' if a fault is thrown, this classes 'onFault' method will be called. Invoke should rethrow any exceptions it catches, wrapped in an AxisFault.

Specified by:
invoke in interface Handler (src)
Overrides:
invoke in class SimpleChain (src)
Throws:
AxisFault (src)