net.xoetrope.optional.service
Class XRouteManager

java.lang.Object
  net.xoetrope.optional.service.XRouteManager

public class XRouteManager
extends java.lang.Object

Constructs service call routes from an XML descriptor. XRouteManager caches routes so that they can be resused once constructed. The startup properties file lists the datasets file in its ModelData entry. e.g.

 UseWindow=false
 ClientWidth=800
 ClientHeight=600
 StartPackage=net.xoetrope.myPackage
 StartClass=myStartScreen
 Title=My Application
 StyleFile=myStyles.txt
 ModelData=datasets.xml
 CenterWin=false
 XDataSourceClass=net.xoetrope.xlib.data.XLibDataSource
 

The dataset then points to a datasource, usually called routes.xml.

 <?xml version="1.0" encoding="UTF-8"?>
 <DataSources>
         <DataSource name="Tables" type="database" filename="tables.xml"/>
         <DataSource name="ListValues" filename="datasources.xml"/>
         <DataSource name="Routes" type="routing" filename="routes.xml"/>
         <DataSource name="Services" type="service" filename="services.xml"/>
 </DataSources>
 

This XML file describes each named route as a series of layers with separate entries for the client (local) and server (remote) sides.

  <?xml version="1.0" encoding="UTF-8"?>
  <Routes>
          <route name="myRemoteService">
                  <layer class="net.xoetrope.service.XHttpClientServiceProxy" url="http://localhost:8080/xserviceservlet" urlEncode="false"/>
          </route>
          <route name="myCalculationService">
                  <layer class="net.xoetrope.service.test.CalcTestService"/>
          </route>
  </Routes>
 

The route manager is used in conjunction with the XServiceModelNode as the following fragement of test code looking up and invoking shows:

     XRouteManager routeMgr = XRouteManager.getInstance();
     XServiceModelNode node = new XServiceModelNode();
     try {
       node.setupService( "getName", routeMgr.getRoute( "myCalculationService" ), null );
       Object result = node.get();
       assertTrue( result.toString().compareTo( CalcTestService.class.getName() ) == 0 );
       ...
 

Normally this method of invoking a service would not be used as the services can more easily be invoked by looking up the XServiceModelNode in the overall XModel. The nodes in the XModel are configured via the Services datasource as follow:

 <?xml version="1.0" encoding="UTF-8"?>
 <Services>
         <service name="calcVolume" route="remote" processor="net.xoetrope.service.test.CalcTestService">
                 <arg name="roomWidth" type="double"/>
                 <arg name="roomLength" type="double"/>
                 <arg name="roomHeight" type="double"/>
                 <return type="double"/>
         </service>
         <service name="calcRepayments" route="remote">
                 <arg name="term" type="int" mandatory="true"/>
                 <arg name="value" type="double" mandatory="true"/>
                 <arg name="deposit" type="double" mandatory="false"/>
         </service>
         <service name="getName" route="calcRoute">
                 <return type="String"/>
         </service>
         <service name="getNumber" route="calcRoute">
                 <return type="int"/>
         </service>
 </Services>
 

The service can then be invoked via the model as in the following example.

  try {
    XServiceModelNode node = (XServiceModelNode)XModel.getInstance().get( "calcVolume" );
    node.setAttribValue( 0, new Double( 3.9 ));
    node.setAttribValue( 1, new Double( 4.6 ));
    node.setAttribValue( 2, new Double( 2.5 ));
    Object result = node.get();
    assertTrue( result instanceof Double );
    assertTrue( ((Double)result).doubleValue() == 101.0  );
  }
  catch ( Exception ex ) {
    ex.printStackTrace();
  }

Note that on the server side of a remote call the services may need to be implemented in the reverse order and in a slightly different order i.e. the server side will have to provide an implementation of the service.

Copyright (c) Xoetrope Ltd., 2001-2006, see license.txt for details

Field Summary

static int	CLIENT_SIDE final to indicate that the route exists on the client side
protected XProject	currentProject The owner project
protected java.util.Hashtable	routes Hashtable used to store the routes
static int	SERVER_SIDE final to indicate that the route exists on the server side

Constructor Summary

XRouteManager(XProject project)
null ctor.

Method Summary

void	addRoute(java.lang.String name, java.util.Hashtable[] layers) Add the named route to the routes Hashtable
ServiceProxy	getRoute(java.lang.String route) Retrive the named ServiceProxy route
ServiceProxy	getRoute(java.lang.String route, java.lang.String serviceImplementationClass) Retrive the named ServiceProxy route
void	setSide(int s) Flags the route manager as being on the client or server side
static XRouteManager	setupRouteManager(XProject project) Setup and instance of the route manager for a project

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLIENT_SIDE

public static final int CLIENT_SIDE

final to indicate that the route exists on the client side

See Also:

Constant Field Values

SERVER_SIDE

public static final int SERVER_SIDE

final to indicate that the route exists on the server side

See Also:

Constant Field Values

routes

protected java.util.Hashtable routes

Hashtable used to store the routes

currentProject

protected XProject currentProject

The owner project

Constructor Detail

XRouteManager

public XRouteManager(XProject project)

null ctor. Create the routes Hashtable to store the routes

Method Detail

setSide

public void setSide(int s)

Flags the route manager as being on the client or server side

Parameters:

s - The side on which the route is being run. Either CLIENT_SIDE or SERVER_SIDE

setupRouteManager

public static XRouteManager setupRouteManager(XProject project)

Setup and instance of the route manager for a project

Parameters:

project - The current XUI project

Returns:

The XRouteManager Singleton instance

getRoute

public ServiceProxy getRoute(java.lang.String route)
                      throws XServiceProxyNotFoundException

Retrive the named ServiceProxy route

Parameters:

route - the route name

Returns:

the service route

Throws:

XServiceProxyNotFoundException - Throw if the route cannot be found

getRoute

public ServiceProxy getRoute(java.lang.String route,
                             java.lang.String serviceImplementationClass)
                      throws XServiceProxyNotFoundException

Retrive the named ServiceProxy route

Parameters:

route - the route name

serviceImplementationClass - the service implementation class if this is a new route or if a route is being customized by an additional service class

Returns:

the service route

Throws:

XServiceProxyNotFoundException - Throw if the route cannot be found

addRoute

public void addRoute(java.lang.String name,
                     java.util.Hashtable[] layers)

Add the named route to the routes Hashtable

Parameters:

name - The name under which the route is being added to the routes Hashtable

layers - Hashtable of ServiceProxy layers making up the routes