com.webobjects.webservices.client
Class WOWebService

java.lang.Object
  |
  +--com.webobjects.webservices.client.WOWebService

public class WOWebService

extends Object

A WOWebService represents a single SOAP HTTP service as defined in a WSDL document. It can be used to introspect the operations implemented on the Web service, or to create a call which can be used to invoke a given operation. A WOWebService is capable of maintaing session state through multiple invocations of operations on the Web service.

See Also:

org.apache.axis.client.Service, org.apache.axis.client.Call

Nested Class Summary

static class

WOWebService.SessionInfo SessionInfo stores all data required to connect to an existing Web service sessions.

Constructor Summary

WOWebService(QName aQName, URL aURL)
Create and initialize a new instance of WOWebService.

Method Summary

Service	axisService() Returns the underlying Axis service used to make Web service invocations.
Call	createCallForOperation(String opName) Creates an returns an Axis call object for the operation opName.
EngineConfiguration	engineConfiguration() Return the EngineConfiguration used by the underlying Axis service.
boolean	isOperationDocumentStyle(String name) Returns true if the operation name is document style, false otherwise.
boolean	isOperationRPCStyle(String name) Returns true if the operation name is RPC style, false otherwise.
String	name() Returns the local part of the QName of the service.
WOClientOperation	operationNamed(String name) Return the operation named name.
NSDictionary	operationsDictionary() Return an NSDictionary containing name to WOClientOperation mappings for all operations published in this service.
QName	qName() Returns the QName of the service.
void	registerFactoriesForClassWithQName(SerializerFactory sFactory, DeserializerFactory dFactory, Class aClass, QName aQName) Register aSerializerFactory for serializing objects of class aClass and aDeserializerFactory for deserializing DOM elements with QName aQName.
WOWebService.SessionInfo	sessionInfo() Return an opaque SessionInfo object which can be used to transfer session information between instances of WOWebService.
void	setEngineConfiguration(EngineConfiguration aConfig) Set the EngineConfiguration to used by the underlying Axis service.
void	setSecurityDelegate(Object aDelegate)
void	setSessionInfo(WOWebService.SessionInfo aSessionInfo) Set the session information for the service to the values contained in aSessionInfo.
String	toString()
Class	typeForQName(QName aQname) Return the class to which DOM elements with name aQName will be deserialized.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

WOWebService

public WOWebService(QName aQName,
                    URL aURL)

Create and initialize a new instance of WOWebService.

Parameters:

aQName - the QName of the service

aURL - the URL at which the WSDL for this service can be found

Method Detail

axisService

public Service axisService()

Returns the underlying Axis service used to make Web service invocations.

Returns:

the underlying Axis service

See Also:

org.apache.axis.client.Service

createCallForOperation

public Call createCallForOperation(String opName)
                            throws javax.xml.rpc.ServiceException

Creates an returns an Axis call object for the operation opName.

Parameters:

opName - String name of operation to be invoked

Returns:

Axis call object that can be used to invoke the operation

javax.xml.rpc.ServiceException

See Also:

org.apache.axis.client.Call

engineConfiguration

public EngineConfiguration engineConfiguration()

Return the EngineConfiguration used by the underlying Axis service.

Returns:

the org.apache.axis.EngineConfiguration for the receiver

isOperationDocumentStyle

public boolean isOperationDocumentStyle(String name)

Returns true if the operation name is document style, false otherwise.

Parameters:

name - the name of the operation being checked

Returns:

true if name is a document style operation

isOperationRPCStyle

public boolean isOperationRPCStyle(String name)

Returns true if the operation name is RPC style, false otherwise.

Parameters:

name - the name of the operation being checked

Returns:

true if name is a SOAP RPC style operation

name

public String name()

Returns the local part of the QName of the service.

Returns:

the name of the service

operationNamed

public WOClientOperation operationNamed(String name)

Return the operation named name.

Parameters:

name - the name of the operation being requested

Returns:

an instance of WOClientOperation or null

operationsDictionary

public NSDictionary operationsDictionary()

Return an NSDictionary containing name to WOClientOperation mappings for all operations published in this service.

Returns:

an NSDictionary of WOClientOperation instances

qName

public QName qName()

Returns the QName of the service.

Returns:

the QName of the service

registerFactoriesForClassWithQName

public void registerFactoriesForClassWithQName(SerializerFactory sFactory,
                                               DeserializerFactory dFactory,
                                               Class aClass,
                                               QName aQName)

Register aSerializerFactory for serializing objects of class aClass and aDeserializerFactory for deserializing DOM elements with QName aQName. Objects serialized by aSerializerFactory will have a QName of aQName. If a aSerializerFactory is null, only aDeserializerFactory will be registered, and vice versa.

Parameters:

aClass - Class which aSerializerFactory should be used to serialize

aQName - QName defining elements that aDeserializerFactory should be used to deserialize

sessionInfo

public WOWebService.SessionInfo sessionInfo()

Return an opaque SessionInfo object which can be used to transfer session information between instances of WOWebService. If there is no session information, will return an empty SessionInfo.

Returns:

a SessionInfo object

setEngineConfiguration

public void setEngineConfiguration(EngineConfiguration aConfig)

Set the EngineConfiguration to used by the underlying Axis service. If the service has already been created, the existing instance will be freed.

Note: If you reset the service's engine configuration, all existing session information for the service will be lost.

Parameters:

aConfig - an org.apache.axis.EngineConfiguration

setSecurityDelegate

public void setSecurityDelegate(Object aDelegate)

setSessionInfo

public void setSessionInfo(WOWebService.SessionInfo aSessionInfo)

Set the session information for the service to the values contained in aSessionInfo.

Note: If after setting session information, you reset the service's engine configuration, all session information will be lost.

Parameters:

aSessionInfo - object containing session information

See Also:

WOWebService.SessionInfo

toString

public String toString()

Overrides:

toString in class Object

typeForQName

public Class typeForQName(QName aQname)

Return the class to which DOM elements with name aQName will be deserialized. Will return null if there is no deserializer registered for aQName

Returns:

the class to which aQName will deserialize, or null