org.apache.axis.handlers.soap

Class SOAPService

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@apache.org) Doug Davis (dug@us.ibm.com)

Field Summary
intnextObjectID
MapserviceObjects
A list of our active service objects (these can have lifetimes and be reaped)
Constructor Summary
SOAPService()
Standard, no-arg constructor.
SOAPService(Handler reqHandler, Handler pivHandler, Handler respHandler)
Constructor with real or null request, pivot, and response handlers.
SOAPService(Handler serviceHandler)
Convenience constructor for wrapping SOAP semantics around "service handlers" which actually do work.
Method Summary
voidaddSession(Session session)
Add this passed in Session to this Service's list of sessions
booleanavailableFromTransport(String transportName)
voidclearSessions()
Remove all of this Service's serviceObjects from it known sessions
voiddisableTransport(String transportName)
Disable access to this service from a particular transport
voidenableTransport(String transportName)
Make this service available on a particular transport
voidgenerateWSDL(MessageContext msgContext)
Generate WSDL.
ArrayListgetActors()
Get the merged actor list for this service, including engine-wide actor URIs.
AxisEnginegetEngine()
ServiceDescgetInitializedServiceDesc(MessageContext msgContext)
Returns a service description with the implementation class filled in.
ListgetRoles()
intgetSendType()
ArrayListgetServiceActors()
Get the service-specific actor list
ServiceDescgetServiceDescription()
StylegetStyle()
TypeMappingRegistrygetTypeMappingRegistry()
UsegetUse()
voidinvoke(MessageContext msgContext)
booleanisRunning()
Is this service suspended?
booleanneedsHighFidelityRecording()
voidsetEngine(AxisEngine engine)
Tell this service which engine it's deployed to.
voidsetHighFidelityRecording(boolean highFidelityRecording)
voidsetPropertyParent(Hashtable parent)
voidsetRoles(List roles)
Set the service-specific role list
voidsetSendType(int sendType)
voidsetServiceDescription(ServiceDesc serviceDescription)
voidsetStyle(Style style)
voidsetUse(Use style)
voidstart()
Placeholder for "resume this service" method
voidstop()
Placeholder for "suspend this service" method

Field Detail

nextObjectID

public int nextObjectID

serviceObjects

public Map serviceObjects
A list of our active service objects (these can have lifetimes and be reaped)

Constructor Detail

SOAPService

public SOAPService()
Standard, no-arg constructor.

SOAPService

public SOAPService(Handler reqHandler, Handler pivHandler, Handler 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 serviceHandler)
Convenience constructor for wrapping SOAP semantics around "service handlers" which actually do work.

Method Detail

addSession

public void addSession(Session session)
Add this passed in Session to this Service's list of sessions

availableFromTransport

public boolean availableFromTransport(String transportName)

clearSessions

public void clearSessions()
Remove all of this Service's serviceObjects from it known sessions

disableTransport

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

enableTransport

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

generateWSDL

public void generateWSDL(MessageContext msgContext)
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.

getActors

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

Returns:

getEngine

public AxisEngine getEngine()

getInitializedServiceDesc

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

getRoles

public List getRoles()

getSendType

public int getSendType()

getServiceActors

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

Returns:

getServiceDescription

public ServiceDesc getServiceDescription()

getStyle

public Style getStyle()

getTypeMappingRegistry

public TypeMappingRegistry getTypeMappingRegistry()

getUse

public Use getUse()

invoke

public void invoke(MessageContext msgContext)

isRunning

public boolean isRunning()
Is this service suspended?

Returns:

needsHighFidelityRecording

public boolean needsHighFidelityRecording()

setEngine

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

setHighFidelityRecording

public void setHighFidelityRecording(boolean highFidelityRecording)

setPropertyParent

public void setPropertyParent(Hashtable parent)

setRoles

public void setRoles(List roles)
Set the service-specific role list

Parameters: roles a List of Strings, each containing a role URI

setSendType

public void setSendType(int sendType)

setServiceDescription

public void setServiceDescription(ServiceDesc serviceDescription)

setStyle

public void setStyle(Style style)

setUse

public void setUse(Use style)

start

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

stop

public void stop()
Placeholder for "suspend this service" method
Copyright B) 2005 Apache Web Services Project. All Rights Reserved.