com.ibm.wsgw.beans
Interface Routing

All Known Subinterfaces:
RoutingRemote

public interface Routing

The Routing interface encapsulates a service which manages routing for requests.

Filters may use this service to select the target service and port.

Version:
1.11
Author:
 
See Also:

Field Summary
static java.lang.String copyright
          Copyright string.
static java.lang.String JNDI_NAME
          The JNDI location at which the Annotation service is to be found.
 
Method Summary
 TargetServiceLocation getSelectedTargetServiceLocation(org.apache.wsif.WSIFRequest request)
          Returns the currently selected target service for the request.
 java.lang.String getTargetPortName(org.apache.wsif.WSIFRequest request)
          Returns the currently selected target port name for the request.
 javax.wsdl.Definition getTargetServiceDefinition(org.apache.wsif.WSIFRequest request, TargetServiceLocation targetServiceLocation)
          Returns the WSDL definition for the target service.
 java.util.Hashtable getTargetServices(org.apache.wsif.WSIFRequest request)
          Returns the target services which are mapped by the gateway service on which the request was received.
 org.apache.wsif.WSIFRequest setSelectedTargetServiceIdentity(org.apache.wsif.WSIFRequest request, java.lang.String targetServiceIdentity)
          Sets the selected target service for the request.
 org.apache.wsif.WSIFRequest setSelectedTargetServiceLocation(org.apache.wsif.WSIFRequest request, TargetServiceLocation targetServiceLocation)
          Sets the selected target service for the request.
 org.apache.wsif.WSIFRequest setTargetPortName(org.apache.wsif.WSIFRequest request, java.lang.String portName)
          Sets the currently selected target port name for the request.
 

Field Detail

copyright

public static final java.lang.String copyright
Copyright string. Any code placed between the comments will be over written

JNDI_NAME

public static final java.lang.String JNDI_NAME
The JNDI location at which the Annotation service is to be found.
Method Detail

getTargetServices

public java.util.Hashtable getTargetServices(org.apache.wsif.WSIFRequest request)
                                      throws WSGWException,
                                             java.rmi.RemoteException
Returns the target services which are mapped by the gateway service on which the request was received.

The table which is returned contains the target service WSDL location strings as keys, and the target service identity information strings as the values.

Parameters:
request - The request.
Returns:
The table of target services.
Throws:
WSGWException - An error occurred.
java.rmi.RemoteException - Required for EJB remote interfaces.
See Also:

setSelectedTargetServiceLocation

public org.apache.wsif.WSIFRequest setSelectedTargetServiceLocation(org.apache.wsif.WSIFRequest request,
                                                                    TargetServiceLocation targetServiceLocation)
                                                             throws WSGWException,
                                                                    java.rmi.RemoteException
Sets the selected target service for the request.

The target service is identified by the location string for its WSDL definition.

The selected port name if any is reset by this call.

Parameters:
request - The request.
targetServiceLocation - The selected target service WSDL location.
Returns:
The WSIFRequest object with updated information.
Throws:
WSGWException - The target service location is not valid.
java.rmi.RemoteException - Required for EJB remote interfaces.
See Also:

setSelectedTargetServiceIdentity

public org.apache.wsif.WSIFRequest setSelectedTargetServiceIdentity(org.apache.wsif.WSIFRequest request,
                                                                    java.lang.String targetServiceIdentity)
                                                             throws WSGWException,
                                                                    java.rmi.RemoteException
Sets the selected target service for the request.

The target service is identified by the identity string. The Routing service selects the first target service with an exactly equal identity string (using String.equals()).

The selected port name if any is reset by this call.

Parameters:
request - The request.
targetServiceIdentity - The target service location.
Returns:
The WSIFRequest object with updated information.
Throws:
WSGWException - There are no target services matching the supplied identity.
java.rmi.RemoteException - Required for EJB remote interfaces.
See Also:

getSelectedTargetServiceLocation

public TargetServiceLocation getSelectedTargetServiceLocation(org.apache.wsif.WSIFRequest request)
                                                       throws WSGWException,
                                                              java.rmi.RemoteException
Returns the currently selected target service for the request.

The target service is identified by the location string for its WSDL definition.

Parameters:
request - The request.
Returns:
The currently selected target service for the request.
Throws:
WSGWException - No target service has been selected.
java.rmi.RemoteException - Required for EJB remote interfaces.
See Also:

getTargetPortName

public java.lang.String getTargetPortName(org.apache.wsif.WSIFRequest request)
                                   throws java.rmi.RemoteException,
                                          WSGWException
Returns the currently selected target port name for the request.
Parameters:
request - The request.
Returns:
The currently selected target port name for the request.
Throws:
WSGWException - An error occurred obtaining the target port name.
java.rmi.RemoteException - Required for EJB remote interfaces.
See Also:

setTargetPortName

public org.apache.wsif.WSIFRequest setTargetPortName(org.apache.wsif.WSIFRequest request,
                                                     java.lang.String portName)
                                              throws WSGWException,
                                                     java.rmi.RemoteException
Sets the currently selected target port name for the request.
Parameters:
request - The request.
portName - The port name to be selected.
Returns:
The WSIFRequest object with updated information.
Throws:
WSGWException - The port name is not valid.
java.rmi.RemoteException - Required for EJB remote interfaces.
See Also:

getTargetServiceDefinition

public javax.wsdl.Definition getTargetServiceDefinition(org.apache.wsif.WSIFRequest request,
                                                        TargetServiceLocation targetServiceLocation)
                                                 throws java.rmi.RemoteException,
                                                        WSGWException
Returns the WSDL definition for the target service.
Parameters:
request - The request.
targetServiceLocation - The target service location.
Returns:
The target service definition.
Throws:
WSGWException - The target service location is not valid.
java.rmi.RemoteException - Required for EJB remote interfaces.
See Also:


Copyright © 2002 IBM. All Rights Reserved.