Style Intelligence v12.0

inetsoft.uql.service
Class RemoteHandler

java.lang.Object
  extended by inetsoft.uql.service.XHandler
      extended by inetsoft.uql.service.RemoteHandler
All Implemented Interfaces:
Serializable

public class RemoteHandler
extends XHandler

Specialization of XHandler that acts as a stub for a handler on a team server.

Since:
11.3
See Also:
Serialized Form

Field Summary
 
Fields inherited from class inetsoft.uql.service.XHandler
repository
 
Constructor Summary
RemoteHandler(Object session, XDataSource dx, VariableTable params, inetsoft.util.repository.ServerRepository repository)
          Creates a new instance of RemoteHandler.
 
Method Summary
 void close()
          Close the data source connection.
 void connect(XDataSource datasource, VariableTable params)
          Connect to the data source.
 XNode execute(XQuery query, VariableTable params, Principal user, inetsoft.util.DataCacheVisitor visitor)
          Execute the query.
 XNode getMetaData(XNode mtype)
          Build the meta data of this data source as a XNode tree.
 void testDataSource(XDataSource datasource, VariableTable params)
          Test the data source.
 
Methods inherited from class inetsoft.uql.service.XHandler
getQueryKey, postProcess, prepareVariableTable, reset, reset, setRepository, setSession
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RemoteHandler

public RemoteHandler(Object session,
                     XDataSource dx,
                     VariableTable params,
                     inetsoft.util.repository.ServerRepository repository)
              throws Exception
Creates a new instance of RemoteHandler.

Parameters:
session - the data session key.
dx - the data source.
params - the connection parameters.
repository - the repository that contains the configuration of the team server.
Throws:
Exception - if the remote handler could not be created.
Method Detail

execute

public XNode execute(XQuery query,
                     VariableTable params,
                     Principal user,
                     inetsoft.util.DataCacheVisitor visitor)
              throws Exception
Execute the query.

Specified by:
execute in class XHandler
params - parameters for query.
Returns:
the result as a hierarchical tree.
Throws:
Exception

connect

public void connect(XDataSource datasource,
                    VariableTable params)
             throws Exception
Connect to the data source.

Specified by:
connect in class XHandler
Parameters:
datasource - the data source name.
params - parameters for connection.
Throws:
Exception

testDataSource

public void testDataSource(XDataSource datasource,
                           VariableTable params)
                    throws Exception
Test the data source.

Specified by:
testDataSource in class XHandler
Parameters:
datasource - the data source name.
params - parameters for connection.
Throws:
Exception

getMetaData

public XNode getMetaData(XNode mtype)
                  throws Exception
Build the meta data of this data source as a XNode tree. This method will rebuild the meta data tree everytime it's called. The meta data should be cached by the caller.

Specified by:
getMetaData in class XHandler
Parameters:
mtype - meta data type, defined in each data source.
Returns:
return the root node of the meta data tree.
Throws:
Exception

close

public void close()
           throws Exception
Close the data source connection.

Specified by:
close in class XHandler
Throws:
Exception

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.