WebLogic Server 6.1 API Reference

weblogic.soap
Class SoapMethod

java.lang.Object
  |
  +--weblogic.soap.SoapMethod

public class SoapMethod

extends java.lang.Object

Represents a method of a web service that can be invoked by the WebServiceProxy

Author:

Copyright © 2001 BEA Systems, Inc. All Rights Reserved.

Method Summary

java.lang.String	getEncodingStyle() returns the encoding style to be used to encode/decode the parameters and the return value.
java.lang.String	getName() returns the name of this method
java.lang.String	getObjectUrl() returns the object url.
SoapType[]	getParameters() returns an array of parameter types specified for this method.
SoapType	getReturnType() returns the return type of this method.
java.lang.String	getSoapAction() returns the soap action set for this method
java.lang.Object	invoke(java.lang.Object[] parameters) invokes this method with the specified arguments.
void	setEncodingStyle(java.lang.String encodingStyle) sets an encoding style for this method.
void	setObjectUrl(java.lang.String objectUrl) sets the value of the target object url.
void	setSoapAction(java.lang.String soapAction) sets the value of soap action.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getObjectUrl

public java.lang.String getObjectUrl()

returns the object url. this url is used to identify the target object at the server side.

Returns:

object url or null.

setObjectUrl

public void setObjectUrl(java.lang.String objectUrl)

sets the value of the target object url.

Parameters:

objectUrl - url to the target object

getName

public java.lang.String getName()

returns the name of this method

Returns:

name of the method

getSoapAction

public java.lang.String getSoapAction()

returns the soap action set for this method

Returns:

soap action or null if it is not set

setSoapAction

public void setSoapAction(java.lang.String soapAction)

sets the value of soap action. soap action can be null, null string, or a uri. ref the soap spec for details.

Parameters:

soapAction - soap action to be set

getEncodingStyle

public java.lang.String getEncodingStyle()

returns the encoding style to be used to encode/decode the parameters and the return value. default for encoding style is soap encoding.

Returns:

encoding style used.

setEncodingStyle

public void setEncodingStyle(java.lang.String encodingStyle)

sets an encoding style for this method.

Parameters:

encodingStyle - encoding style to be used. The specified style should be a valid encoding style known to the Codec Factory in use.

getReturnType

public SoapType getReturnType()

returns the return type of this method.

Returns:

return type

getParameters

public SoapType[] getParameters()

returns an array of parameter types specified for this method.

Returns:

parameter types

invoke

public java.lang.Object invoke(java.lang.Object[] parameters)
                        throws java.io.IOException,
                               org.xml.sax.SAXException

invokes this method with the specified arguments. this method is very similar to the java.lang.reflect.Method.invoke();

Parameters:

parameters - parameters needed to invoke this method. the number of parameters and the type of each parameter should match the type infomation provided while creating this method.

Returns:

result of the invocation.

Throws:

java.io.IOException - failed to connect the server or failed to read data from the stream.

org.xml.sax.SAXException - failed to create the XML request or failed to parse the XML response document.

See Also:

Method.invoke( Object, Object[] )

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object