org.apache.jetspeed.webservices.util
Class SoapAccessBean

java.lang.Object
  org.apache.jetspeed.webservices.util.SoapAccessBean

All Implemented Interfaces:

java.io.Serializable

public class SoapAccessBean

extends java.lang.Object

implements java.io.Serializable

SoapAccessBean provides a Soap WebServices Client command bean pattern. This bean can be used to interact with webservices via soap. The WSDL file for the target web service is required since it contains the parameters required to interact with the service.

Version:

1.0

Author:

Scott A. Roehrig

See Also:

Serialized Form

Constructor Summary

SoapAccessBean()
Default constructor required to support Serialization.

SoapAccessBean(java.lang.String targetURI, java.lang.String method)
Creates new SoapAccessBean with parameters specified.

Method Summary

void	addParameter(java.lang.String paramName, java.lang.Class paramClass, java.lang.Object paramValue, java.lang.String encoding) Adds the needed parameter to the request.
java.util.Vector	getParameters() Parameters property getter method.
java.lang.Object	processRequest(java.lang.String url) Processes client service requests.
void	setParameters(java.util.Vector parameters) Setter method for parameters property.

Methods inherited from class java.lang.Object

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

Constructor Detail

SoapAccessBean

public SoapAccessBean()

Default constructor required to support Serialization.

SoapAccessBean

public SoapAccessBean(java.lang.String targetURI,
                      java.lang.String method)

Creates new SoapAccessBean with parameters specified.

Parameters:

targetURI - type: java.lang.String - desc: targetURI for the services

method - type: java.lang.String - desc: service method

Method Detail

setParameters

public void setParameters(java.util.Vector parameters)

Setter method for parameters property. The parameters property is used to set the various parameters required to interact with the service.

Parameters:

parameters - type: java.util.Vector - desc: stores service parameters

getParameters

public java.util.Vector getParameters()

Parameters property getter method.

Returns:

java.util.Vector - desc: stores service parameters

addParameter

public void addParameter(java.lang.String paramName,
                         java.lang.Class paramClass,
                         java.lang.Object paramValue,
                         java.lang.String encoding)

Adds the needed parameter to the request. The parameters required by the service are defined within its WSDL descriptor file

Parameters:

paramName - type: java.lang.String - desc: the parameter name

paramClass - type: java.lang.Class - desc: the class of the parameter

paramValue - type:java.lang.Object - desc: the parameter

encoding - type:java.lang.String - desc: the parameter encoding

processRequest

public java.lang.Object processRequest(java.lang.String url)
                                throws org.apache.soap.SOAPException

Processes client service requests.

Parameters:

url - type: java.lang.String - desc: the service endpoint url defined in the WSDL file

Returns:

java.lang.Object - desc: the results of the service request must be cast by caller

Throws:

org.apache.soap.SOAPException - type: org.apache.soap.SOAPException - desc: thrown if an exception occurs contains details of the exception