oracle.adfinternal.model.adapter.webservice.provider.soap

Class SOAPProvider

java.lang.Object

oracle.adfinternal.model.adapter.webservice.provider.soap.SOAPProvider

All Implemented Interfaces:

WSProvider

public class SOAPProvider
extends java.lang.Object
implements WSProvider

Concrete Data control Provider implementation for the SOAP binding.

The SOAPProvider allows the Data Control to invoke Webservices defined for SOAP bindings. The provider abstracts out the invocation protocol details at the Data Control level.

The SOAPProvider is intialized from the metadata configuration. The Provider intializes all the necessary classes to convert the operaton invocation requests to SOAP payload and return the response payload as an iterator of maps. For the Data control, the underlying classes used by the provider are not visible, neither is the data control aware of the existance of these instances. All operation invocations by the data control happen via the provider.

The provider is also repsonsible for processing the SOAP messages for security. The Data control registers the security implmentation via a standard interface DCSecurity. The SOAPProvider uses the registered implementation to enable SOAP message level security.

Since:

10.1.3

See Also:

SOAPOperation, DCSecurity

Field Summary

Fields inherited from interface oracle.adfinternal.model.adapter.webservice.provider.WSProvider

PROVIDER_CONNECTION, PROVIDER_DCDEF, PROVIDER_OPERATIONS, PROVIDER_SEC_MODEL, PROVIDER_SERVICE

Constructor Summary

Constructors

Constructor and Description
SOAPProvider() Create the instance of this SOAPProvider

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	execute(java.lang.String operationName, java.util.Map params) Invoke the service operation Create the request payload against the endpoint URL.
javax.xml.soap.SOAPMessage	getRequest() Get the SOAP request message for the previous webservice call invoked.
javax.xml.soap.SOAPMessage	getResponse() Get the SOAP response message for the previous webservice call invoked.
protected void	handleFault(javax.xml.soap.SOAPFault fault) Handle the SOAP fault if the repsonse generated one.
protected java.util.Map<java.lang.String,java.util.List>	handleHttpHeaders(java.util.Map httpHeaders) The method creates an instance of Map<String,List> by merging the contents of httpHeaders passed by method.
protected void	handleRequest(javax.xml.soap.SOAPMessage mRequest) Override this method for custom manipulation of the SOAPRequest.
protected void	handleResponse(javax.xml.soap.SOAPMessage mResponse) Override this method for custom processing the SOAPResponse obtained.
void	init(java.util.Map environment) Initialize the Provider with the DC environment.
void	setSecurityModel(SecurityModel security) Set the Security Model for this provider.

Methods inherited from class java.lang.Object

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

Constructor Detail

SOAPProvider

public SOAPProvider()

Create the instance of this SOAPProvider

Method Detail

init

public void init(java.util.Map environment)

Initialize the Provider with the DC environment. The DC can initialize the provider with parameters such as supported operations, the underlying connection to use and any other parameter needed by the provider to make a successful invocation of the operation.

Specified by:

init in interface WSProvider

Parameters:

environment - The Parameters needed by this provider to make a successful invocation of the DC operation.

execute

public java.lang.Object execute(java.lang.String operationName,
                       java.util.Map params)
                         throws AdapterException

Invoke the service operation Create the request payload against the endpoint URL. Enable the message level security if the security implementation is registered. The response is processed and iterator of maps is created and returned to the data control

Specified by:

execute in interface WSProvider

Parameters:

operationName - The name of the operation to be invoked.

params - The parameters for this operation invocation.

Returns:

The result of this operation invocation. The provider sends the result back as an iterator of maps.

Throws:

{@link - AdapterException} if the invocation fails.

AdapterException

getRequest

public javax.xml.soap.SOAPMessage getRequest()

Get the SOAP request message for the previous webservice call invoked. Note that this will return a valid SOAP Message only if a "exceute" has been invoked on the provider.

Returns:

SOAP request Message

getResponse

public javax.xml.soap.SOAPMessage getResponse()

Get the SOAP response message for the previous webservice call invoked. Note that this will return a valid SOAP Message only if a "exceute" has been invoked on the provider.

Returns:

SOAP response Message

setSecurityModel

public void setSecurityModel(SecurityModel security)

Description copied from interface: WSProvider

Set the Security Model for this provider.

Specified by:

setSecurityModel in interface WSProvider

Parameters:

security - The security model for this provider.

handleRequest

protected void handleRequest(javax.xml.soap.SOAPMessage mRequest)
                      throws AdapterException

Override this method for custom manipulation of the SOAPRequest.

Parameters:

mRequest - Reference to the SOAPRequest

Throws:

AdapterException

handleResponse

protected void handleResponse(javax.xml.soap.SOAPMessage mResponse)
                       throws AdapterException

Override this method for custom processing the SOAPResponse obtained.

Parameters:

mResponse - Reference to the SOAPResponse

Throws:

AdapterException

handleFault

protected void handleFault(javax.xml.soap.SOAPFault fault)
                    throws AdapterException

Handle the SOAP fault if the repsonse generated one. Override this method for custom processing.

Parameters:

fault - The SOAP fault generated by the response.

Throws:

AdapterException

handleHttpHeaders

protected java.util.Map<java.lang.String,java.util.List> handleHttpHeaders(java.util.Map httpHeaders)

The method creates an instance of Map<String,List> by merging the contents of httpHeaders passed by method. If httpHeaders is null, the method returns an empty map. If the Subclass creates a new HashMap, even if the httpHeaders is not null, they should merge the contents.