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
int	nextObjectID
Map	serviceObjects 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
void	addSession(Session session) Add this passed in Session to this Service's list of sessions
boolean	availableFromTransport(String transportName)
void	clearSessions() Remove all of this Service's serviceObjects from it known sessions
void	disableTransport(String transportName) Disable access to this service from a particular transport
void	enableTransport(String transportName) Make this service available on a particular transport
void	generateWSDL(MessageContext msgContext) Generate WSDL.
ArrayList	getActors() Get the merged actor list for this service, including engine-wide actor URIs.
AxisEngine	getEngine()
ServiceDesc	getInitializedServiceDesc(MessageContext msgContext) Returns a service description with the implementation class filled in.
List	getRoles()
int	getSendType()
ArrayList	getServiceActors() Get the service-specific actor list
ServiceDesc	getServiceDescription()
Style	getStyle()
TypeMappingRegistry	getTypeMappingRegistry()
Use	getUse()
void	invoke(MessageContext msgContext)
boolean	isRunning() Is this service suspended?
boolean	needsHighFidelityRecording()
void	setEngine(AxisEngine engine) Tell this service which engine it's deployed to.
void	setHighFidelityRecording(boolean highFidelityRecording)
void	setPropertyParent(Hashtable parent)
void	setRoles(List roles) Set the service-specific role list
void	setSendType(int sendType)
void	setServiceDescription(ServiceDesc serviceDescription)
void	setStyle(Style style)
void	setUse(Use style)
void	start() Placeholder for "resume this service" method
void	stop() Placeholder for "suspend this service" method

Field Detail

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:

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