xsul.wsif
Interface WSIFService

All Known Implementing Classes:

WSIFServiceImpl

public interface WSIFService

A WSIFService is a factory via which WSIFPorts are retrieved. This follows the J2EE design pattern of accessing resources (WSIFPorts, in this case) via a factory which is retrieved from the context in which the application is running. When WSIF is hosted in an app server, the container can manage service invocation details by providing a factory implementation that follows the app servers wishes and guidelines. The factory is assumed to be for a specific portType; i.e., the factory knows how to factor WSIFPorts for a given portType. As such the getPort() methods do not take portType arguments.
Note: this API is based on Apache WSIF API.

Author:

Aleksander Slominski, Paul Fremantle, Michael Beisiegel, Sanjiva Weerawarana

Method Summary

WSIFPort	getPort() Returns an appropriate WSIFPort for the portType that this factory supports.
WSIFPort	getPort(java.lang.String portName) Returns a WSIFPort for the indicated port.
void	setPreferredPort(java.lang.String portName) Set the preferred port

Method Detail

getPort

public WSIFPort getPort()
                 throws WSIFException

Returns an appropriate WSIFPort for the portType that this factory supports. If the service had multiple ports, which one is returned depends on the specific factory - the factory implementation may use whatever heuristic it feels like to select an "appropriate" one.

Returns:

the new WSIFPort

Throws:

WSIFException - if a suitable port cannot be located.

getPort

public WSIFPort getPort(java.lang.String portName)
                 throws WSIFException

Returns a WSIFPort for the indicated port.

Parameters:

portName - name of the port (local part of the name).

Returns:

the new WSIFPort

Throws:

WSIFException - if the named port is not known or available

setPreferredPort

public void setPreferredPort(java.lang.String portName)
                      throws WSIFException

Set the preferred port

Parameters:

portName - The name of the port to use

Throws:

WSIFException - if something goes wrong