org.apache.wsif
Interface WSIFPort

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ModelWSIFPort, WSIFDefaultPort, WSIFPort_ApacheAxis, WSIFPort_ApacheSOAP, WSIFPort_BSF, WSIFPort_EJB, WSIFPort_Java, WSIFPort_JCA, WSIFPort_Jms, WSIFPort_SoapRMI

public interface WSIFPort
extends java.io.Serializable

A WSIFPort represents the handle by which the operations from the of the of this WSIFPort can be executed. This is an interface which must implemented by specific implementations for the ports. That is, the actual logic is dependent on the binding associated with this port. An interface is used to enable dynamic implementation generation using JDK1.3 dynamic proxy stuff.

Author:
Paul Fremantle, Alekander Slominski, Matthew J. Duftler, Sanjiva Weerawarana, Nirmal Mukhi

Method Summary
 void close()
          Close this port; indicates that the user is done using it.
 WSIFOperation createOperation(java.lang.String operationName)
          Create a new WSIFOperation.
 WSIFOperation createOperation(java.lang.String operationName, java.lang.String inputName, java.lang.String outputName)
          Create a new WSIFOperation.
 WSIFMessage getContext()
          Gets the context information for this WSIFPort.
 void setContext(WSIFMessage context)
          Sets the context information for this WSIFPort.
 boolean supportsAsync()
          Tests if this port supports asynchronous calls to operations.
 boolean supportsSync()
          Tests if this port supports synchronous calls to operations.
 

Method Detail

createOperation

WSIFOperation createOperation(java.lang.String operationName)
                              throws WSIFException
Create a new WSIFOperation. There must be exactly one operation in this port's portType with this name. For overloaded operations see createOperation(String,String,String).

Parameters:
operationName - the name of an operation in this port's portType
Returns:
the new WSIFOperation
Throws:
WSIFException - if something goes wrong

createOperation

WSIFOperation createOperation(java.lang.String operationName,
                              java.lang.String inputName,
                              java.lang.String outputName)
                              throws WSIFException
Create a new WSIFOperation. There must be an operation in this port's portType with this operation name, input message name and output message name. The input message name distinguishes overloaded operations.

Parameters:
operationName - the name of an operation in this port's portType
inputName - the input message name
outputName - the output message name
Returns:
the new WSIFOperation
Throws:
WSIFException - if something goes wrong

close

void close()
           throws WSIFException
Close this port; indicates that the user is done using it. This is only essential for WSIFPorts that are being used in a stateful or resource-shared manner. Responsible stubs will call this if feasible at the right time.

Throws:
WSIFException - if something goes wrong

supportsSync

boolean supportsSync()
Tests if this port supports synchronous calls to operations.

Returns:
true this port support synchronous calls
false this port does not support synchronous calls

supportsAsync

boolean supportsAsync()
Tests if this port supports asynchronous calls to operations.

Returns:
true this port support asynchronous calls
false this port does not support asynchronous calls

getContext

WSIFMessage getContext()
                       throws WSIFException
Gets the context information for this WSIFPort.

Returns:
context
Throws:
WSIFException

setContext

void setContext(WSIFMessage context)
Sets the context information for this WSIFPort.

Parameters:
WSIFMessage - the new context information


Copyright ? 2002, 2006 Apache XML Project. All Rights Reserved.