com.soa.soap

Interface ISoapClient

public interface ISoapClient

Dynamic invocation interface for issuing SOAP requests. The interface is extremely high level taking Java objects as request parameters.

Since:

3.1

Method Summary

Modifier and Type	Method and Description
void	clearInAttachments() Clears the attachments being sent with subsequent invocations.
void	clearInHeaders() Clears the protocol headers being sent with subsequent invocations.
void	clearSecuritySubjects() Clears the security subjects being sent with subsequent invocations.
java.lang.Object	createProxy(java.lang.Class interfaceClass) Creates a proxy interface of the specified class to use as a stub as an alternative to using the dynamic interface.
java.lang.Object	createProxy(java.lang.Class interfaceClass, java.lang.ClassLoader classLoader) Creates a proxy interface of the specified class to use as a stub as an alternative to using the dynamic interface.
java.util.Map	getOutAttachments() Returns the attachments included in the response of the last invocation.
java.util.Map	getOutHeaders() Returns the protocol headers included in the response of the last invocation.
java.lang.Object	invokeRequestReply(java.lang.String operation, java.lang.Object[] parameters) Issues a request with multiple parameter (WSDL 1.1 compatible) with an expected response (an IN-OUT exchange).
void	setConvertCase(boolean convertCase) Typically Java operation names are lower case and WSDL operations are upper case.
void	setInAttachments(java.util.Map attachments) Sets attachments that will be sent with subsequent invocations.
void	setInHeaders(java.util.Map headers) Sets protocol headers that will be sent with subsequent invocations.
void	setSecuritySubjects(java.util.Map subjects) Sets the security subjects associated with subsequent invocations.

Method Detail

invokeRequestReply

java.lang.Object invokeRequestReply(java.lang.String operation,
                                    java.lang.Object[] parameters)
                             throws java.rmi.RemoteException

Issues a request with multiple parameter (WSDL 1.1 compatible) with an expected response (an IN-OUT exchange).

Parameters:

operation - Name of the operation being invoked.

parameters - Array of request parameters. The Object classes must be registered with the WSF engine so that marshaling can be successfully performed.

Returns:

Object representing the response of the invocation.

Throws:

java.rmi.RemoteException - Thrown if a fault occurs during the exchange.

createProxy

java.lang.Object createProxy(java.lang.Class interfaceClass,
                             java.lang.ClassLoader classLoader)

Creates a proxy interface of the specified class to use as a stub as an alternative to using the dynamic interface. The class must conform to the guidelines outlined in the JAC-RPC specification for proper mapping to WSDL.

Parameters:

interfaceClass - Class of the stub.

classLoader - ClassLoader the interfaceClass is loaded from.

Returns:

Object implementing the supplied interface.

createProxy

java.lang.Object createProxy(java.lang.Class interfaceClass)

Creates a proxy interface of the specified class to use as a stub as an alternative to using the dynamic interface. The class must conform to the guidelines outlined in the JAC-RPC specification for proper mapping to WSDL. The interface class is assumed to be loaded in the current Thread's class loader.

Parameters:

interfaceClass - Class of the stub.

Returns:

Object implementing the supplied interface.

setInHeaders

void setInHeaders(java.util.Map headers)

Sets protocol headers that will be sent with subsequent invocations. The headers must be cleared in this interface to cease sending them in invocations.

Parameters:

headers - Map of protocol headers. The key is a String. The value is a DocumentFragment.

clearInHeaders

void clearInHeaders()

Clears the protocol headers being sent with subsequent invocations.

getOutHeaders

java.util.Map getOutHeaders()

Returns the protocol headers included in the response of the last invocation.

Returns:

Map of protocol headers. The key is a String. The value is a DocumentFragment. May return null if no headers included.

setInAttachments

void setInAttachments(java.util.Map attachments)

Sets attachments that will be sent with subsequent invocations. The attachments must be cleared in this interface to cease sending them in invocations.

Parameters:

attachments - Map of attachments. The key is a String. The value is a DataHandler.

getOutAttachments

java.util.Map getOutAttachments()

Returns the attachments included in the response of the last invocation.

Returns:

Map of attachments. The key is a String. The value is a DataHandler.

clearInAttachments

void clearInAttachments()

Clears the attachments being sent with subsequent invocations.

setSecuritySubjects

void setSecuritySubjects(java.util.Map subjects)

Sets the security subjects associated with subsequent invocations. The subjects must be cleared in this interface to cease sending them in invocations.

Parameters:

subjects - Map of security subjects. The key is a String indicating the category of the subject. The value is a javax.security.auth.Subject.

clearSecuritySubjects

void clearSecuritySubjects()

Clears the security subjects being sent with subsequent invocations.

setConvertCase

void setConvertCase(boolean convertCase)

Typically Java operation names are lower case and WSDL operations are upper case. This requires a case conversion to take place for the framework to identify the correct operation. In cases where WSDL operations are also lower case, no conversion is required. This method changes the requirement for case conversion. Case conversion will occur by default.

Parameters:

convertCase - true if case must be converted, false if not. true is the default.