org.ow2.weblab.components.client
Class WebLabClient

java.lang.Object
  org.ow2.weblab.components.client.WebLabClient

public class WebLabClient
extends java.lang.Object

This class implements the proposal made here : http://weblab-project.org/index .php?title=WebLab_user_interfaces/Service_Access_From_WebLab_Portlets It objectives is to provide a unique access point to back-end services and avoid service location configuration on portlet level. Thus portlets can use this class to instanciate one generic service given a specific service URI that identify the service function in WebLab service taxonomy. It is assumed that service URLs follow the simple syntax rules : / For instance, for a Searcher : http://weblab3:8181/lire-engine/searcher For a Configurable service : http://weblab3:8181/open-search-connector/configurable Only the last part, "/searcher" or "/configurable", is important. Note: userURI and usageContext are passed as argument but are not used so far. Later this class may implement a common security level to alter portlets access to services based on user and context. thus these cannot be null.

Author:

gdupont - WebLab team - CASSIDIAN, an EADS company

Date:

2011

Constructor Summary

WebLabClient()

Method Summary

static void	addService(java.lang.String uri, java.lang.String urlString) Add a service in the WebLab client configuration
static org.ow2.weblab.core.services.Analyser	getAnalyser(java.lang.String userURI, java.lang.String usageContext, java.lang.String serviceURI)
static org.ow2.weblab.core.services.Configurable	getConfigurable(java.lang.String userURI, java.lang.String usageContext, java.lang.String serviceURI)
static org.ow2.weblab.core.services.Indexer	getIndexer(java.lang.String userURI, java.lang.String usageContext, java.lang.String serviceURI)
static org.ow2.weblab.core.services.QueueManager	getQueueManager(java.lang.String userURI, java.lang.String usageContext, java.lang.String serviceURI)
static org.ow2.weblab.core.services.ReportProvider	getReportProvider(java.lang.String userURI, java.lang.String usageContext, java.lang.String serviceURI)
static org.ow2.weblab.core.services.ResourceContainer	getResourceContainer(java.lang.String userURI, java.lang.String usageContext, java.lang.String serviceURI)
static org.ow2.weblab.core.services.Searcher	getSearcher(java.lang.String userURI, java.lang.String usageContext, java.lang.String serviceURI)
protected static java.util.Map<java.lang.String,java.lang.String>	getServiceurURLMap() Get the map that links service String to URL and thus real location.
static org.ow2.weblab.core.services.SourceReader	getSourceReader(java.lang.String userURI, java.lang.String usageContext, java.lang.String serviceURI)
static org.ow2.weblab.core.services.Trainable	getTrainable(java.lang.String userURI, java.lang.String usageContext, java.lang.String serviceURI)
static java.net.URL	getWeblabwsdl() Get the location of WebLab WSDL

Methods inherited from class java.lang.Object

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

Constructor Detail

WebLabClient

public WebLabClient()

Method Detail

getServiceurURLMap

protected static java.util.Map<java.lang.String,java.lang.String> getServiceurURLMap()

Get the map that links service String to URL and thus real location. Watch out, this is only for the bad guys since this could mess up with the whole configuration

Returns:

the map of String to URL as String (that's just simpler than messing with java String and URL)

getWeblabwsdl

public static java.net.URL getWeblabwsdl()

Get the location of WebLab WSDL

Returns:

the URL of the WSDL

addService

public static void addService(java.lang.String uri,
                              java.lang.String urlString)
                       throws org.ow2.weblab.core.extended.exception.WebLabCheckedException

Add a service in the WebLab client configuration

Parameters:

uri -

urlString -

Throws:

org.ow2.weblab.core.extended.exception.WebLabCheckedException - is the URL of the new service is invalid.

getAnalyser

public static org.ow2.weblab.core.services.Analyser getAnalyser(java.lang.String userURI,
                                                                java.lang.String usageContext,
                                                                java.lang.String serviceURI)
                                                         throws org.ow2.weblab.core.extended.exception.WebLabCheckedException

Throws:

org.ow2.weblab.core.extended.exception.WebLabCheckedException

getConfigurable

public static org.ow2.weblab.core.services.Configurable getConfigurable(java.lang.String userURI,
                                                                        java.lang.String usageContext,
                                                                        java.lang.String serviceURI)
                                                                 throws org.ow2.weblab.core.extended.exception.WebLabCheckedException

Throws:

org.ow2.weblab.core.extended.exception.WebLabCheckedException

getIndexer

public static org.ow2.weblab.core.services.Indexer getIndexer(java.lang.String userURI,
                                                              java.lang.String usageContext,
                                                              java.lang.String serviceURI)
                                                       throws org.ow2.weblab.core.extended.exception.WebLabCheckedException

Throws:

org.ow2.weblab.core.extended.exception.WebLabCheckedException

getQueueManager

public static org.ow2.weblab.core.services.QueueManager getQueueManager(java.lang.String userURI,
                                                                        java.lang.String usageContext,
                                                                        java.lang.String serviceURI)
                                                                 throws org.ow2.weblab.core.extended.exception.WebLabCheckedException

Throws:

org.ow2.weblab.core.extended.exception.WebLabCheckedException

getReportProvider

public static org.ow2.weblab.core.services.ReportProvider getReportProvider(java.lang.String userURI,
                                                                            java.lang.String usageContext,
                                                                            java.lang.String serviceURI)
                                                                     throws org.ow2.weblab.core.extended.exception.WebLabCheckedException

Throws:

org.ow2.weblab.core.extended.exception.WebLabCheckedException

getResourceContainer

public static org.ow2.weblab.core.services.ResourceContainer getResourceContainer(java.lang.String userURI,
                                                                                  java.lang.String usageContext,
                                                                                  java.lang.String serviceURI)
                                                                           throws org.ow2.weblab.core.extended.exception.WebLabCheckedException

Throws:

org.ow2.weblab.core.extended.exception.WebLabCheckedException

getSearcher

public static org.ow2.weblab.core.services.Searcher getSearcher(java.lang.String userURI,
                                                                java.lang.String usageContext,
                                                                java.lang.String serviceURI)
                                                         throws org.ow2.weblab.core.extended.exception.WebLabCheckedException

Throws:

org.ow2.weblab.core.extended.exception.WebLabCheckedException

getSourceReader

public static org.ow2.weblab.core.services.SourceReader getSourceReader(java.lang.String userURI,
                                                                        java.lang.String usageContext,
                                                                        java.lang.String serviceURI)
                                                                 throws org.ow2.weblab.core.extended.exception.WebLabCheckedException

Throws:

org.ow2.weblab.core.extended.exception.WebLabCheckedException

getTrainable

public static org.ow2.weblab.core.services.Trainable getTrainable(java.lang.String userURI,
                                                                  java.lang.String usageContext,
                                                                  java.lang.String serviceURI)
                                                           throws org.ow2.weblab.core.extended.exception.WebLabCheckedException

Throws:

org.ow2.weblab.core.extended.exception.WebLabCheckedException