oracle.adfinternal.model.adapter.webservice.provider
Interface WSProvider

All Known Implementing Classes:

SOAPProvider

public interface WSProvider

Provider interface for the Webservice data control.

Specific providers will need to implement this interface to provide the underlying framework for the webservice invocation. The Data control can invoke a service operation only via the provider interface. This keeps the Adapter framework flexible to use any underlying provider and not bind the adapter to any specific invocation protocol.

Since:

10.1.3

Field Summary

static java.lang.String	PROVIDER_CONNECTION The Actual physical connection for this provider to invoke the service operations.
static java.lang.String	PROVIDER_DCDEF The data control definition for the data control owning this provider By knowing the data control definition and the structure of the operation return nodes & parameter nodes, the provider and organize and process the data appopriately and optimally
static java.lang.String	PROVIDER_OPERATIONS The Operations that the provider can invoke on the service endpoint.
static java.lang.String	PROVIDER_SEC_MODEL
static java.lang.String	PROVIDER_SERVICE The Service attribute that defines the name of the service this provider is capable of servicing, i.e the service against which this provider implementation can invoke operations.

Method Summary

java.lang.Object	execute(java.lang.String operationName, java.util.Map params) Execute a Webservice operation.
void	init(java.util.Map environment) Initialize the provider with the necessary environment to enable the provider to execute the service operation.
void	setSecurityModel(SecurityModel security) Set the Security Model for this provider.

Field Detail

PROVIDER_CONNECTION

static final java.lang.String PROVIDER_CONNECTION

The Actual physical connection for this provider to invoke the service operations. The connection is responsible for the underlying transport of the serialized request to the endpoint.

See Also:

Constant Field Values

PROVIDER_OPERATIONS

static final java.lang.String PROVIDER_OPERATIONS

The Operations that the provider can invoke on the service endpoint. The Set of operations is determined by the owning data control definition.

See Also:

Constant Field Values

PROVIDER_SERVICE

static final java.lang.String PROVIDER_SERVICE

The Service attribute that defines the name of the service this provider is capable of servicing, i.e the service against which this provider implementation can invoke operations.

See Also:

Constant Field Values

PROVIDER_DCDEF

static final java.lang.String PROVIDER_DCDEF

The data control definition for the data control owning this provider By knowing the data control definition and the structure of the operation return nodes & parameter nodes, the provider and organize and process the data appopriately and optimally

See Also:

Constant Field Values

PROVIDER_SEC_MODEL

static final java.lang.String PROVIDER_SEC_MODEL

See Also:

Constant Field Values

Method Detail

init

void init(java.util.Map environment)

Initialize the provider with the necessary environment to enable the provider to execute the service operation. The environment could be any generic parameters such as a physical connection reference or a set of supported operations inaccordence with the data control definition. In addition clients of a provider can pass any custom parameters that is specific to the provider implementation.

Parameters:

environment - The necessary set of parameters to intialize this provider instance to make a successful service operation invocation.

execute

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

Execute a Webservice operation. Concrete implementors will bind this invocation with the underlying protocol. The provider will handle the task of converting the high level opertion invocation to structures needed for the underlying invocation protocol.

Parameters:

operation - The service operation to be invoked

params - Parameters to the service operation.

Throws:

{@link - AdapterException} If the operation invocation fails. It is upto the provider to define what would translate to an invocation failure.

AdapterException

setSecurityModel

void setSecurityModel(SecurityModel security)

Set the Security Model for this provider.

Parameters:

security - The security model for this provider.