oracle.panama.adapter
Interface Adapter

Deprecated.

As of 9.0.2.1.0, replaced by RuntimeAdapter

public interface Adapter

The Interface to be implemented by all Adapters

An Adapter can return result as an XML Element, and the structure should follow either the SimpleResult or the AdapterResult structure.

The Adapter is also responsible to communicate it's definition. And the definition must follow the AdapterDefinition DTD.

The definition is divided into two parts; init and complete where the init must be called before the Adapter is initialized and the complete when the Adapter has been initalized. A typical call sequence in runtime is;

1. Construct adapter
2. Initialize adapter init()
3. Call invoke()
4. Call invoke()
5. ...

A typical call sequence in management time is;

1. Construct adapter
2. Get init definition getInitDefinition()
3. Call init with some values
4. Get the complete "init/input/output" definition getAdapterDefinition()
5. Test the adapter

Method Summary

AdapterDefinition	getAdapterDefinition() Deprecated. The Adapter init/input and output parameters.
AdapterDefinition	getInitDefinition() Deprecated. The Adapter init parameters.
void	init(Arguments args) Deprecated. Init is called only once per life-cycle, right after the Adapter is instansiated.
org.w3c.dom.Element	invoke(ServiceRequest serviceReq) Deprecated. The actual request call to an Adapter.

Method Detail

init

public void init(Arguments args)
          throws AdapterException

Deprecated.

Init is called only once per life-cycle, right after the Adapter is instansiated.

Parameters:

args - The arguments

Throws:

AdapterException - when the parameters are invalid

See Also:

Arguments

invoke

public org.w3c.dom.Element invoke(ServiceRequest serviceReq)
                           throws AdapterException

Deprecated.

The actual request call to an Adapter. Called by the MasterService.

Parameters:

serviceReq - The complete service request

Throws:

AdapterException - when the request is invalid or something else has happened

See Also:

oracle.panama.core.ServiceRequest, AdapterException

getInitDefinition

public AdapterDefinition getInitDefinition()

Deprecated.

The Adapter init parameters. All adapters must be able to define themselves.

Returns:

the AdapterDefinition with init parameters

See Also:

AdapterDefinition

getAdapterDefinition

public AdapterDefinition getAdapterDefinition()
                                       throws AdapterException

Deprecated.

The Adapter init/input and output parameters. All adapters mnust be able to define their parameters depending on how the Adapter was initialized.

Returns:

the complete AdapterDefinition

Throws:

AdapterException - when this adapter is not initialized

See Also:

AdapterDefinition