com.metamatrix.dqp.service
Interface DataService

All Superinterfaces:

ApplicationService

All Known Implementing Classes:

EmbeddedDataService, PlatformDataService

public interface DataService
extends ApplicationService

Defines interface for management of the Data Services, i.e Connectors with which all the physical data is accessed.

Method Summary

void	cancelRequest(AtomicRequestID request, com.metamatrix.dqp.internal.datamgr.ConnectorID connectorId)
void	clearConnectorBindingCache(java.lang.String connectorBindingName) Clear any caches for the connector binding.
void	closeRequest(AtomicRequestID request, com.metamatrix.dqp.internal.datamgr.ConnectorID connectorId)
void	executeRequest(AtomicRequestMessage request, com.metamatrix.dqp.internal.datamgr.ConnectorID connector, ResultsReceiver<AtomicResultsMessage> resultListener) Execute the given request on a Connector.
SourceCapabilities	getCapabilities(RequestMessage request, org.teiid.dqp.internal.process.DQPWorkContext dqpWorkContext, com.metamatrix.dqp.internal.datamgr.ConnectorID connector) Find the capabilities of this source.
java.util.Collection<? extends ConnectionPool>	getConnectionPoolStatistics(java.lang.String connectorBindingName) Get connection pool statistics for connector binding
ConnectorBinding	getConnectorBinding(java.lang.String connectorBindingName) Get the connector binding specifed the name
java.util.List	getConnectorBindings() Get the list of connector bindings deployed in the system.
ConnectorStatus	getConnectorBindingState(java.lang.String connectorBindingName) Get the State of the connector binding name
java.util.Collection	getConnectorBindingStatistics(java.lang.String connectorBindingName) Get connector bindings queue statistics
ConnectorMetadata	getConnectorMetadata(java.lang.String vdbName, java.lang.String vdbVersion, java.lang.String modelName, java.util.Properties importProperties) Return the metadata for a given connector
void	requestBatch(AtomicRequestID request, com.metamatrix.dqp.internal.datamgr.ConnectorID connectorId)
com.metamatrix.dqp.internal.datamgr.ConnectorID	selectConnector(java.lang.String connectorBindingName) Select a connector to use for the given connector binding.
void	startConnectorBinding(java.lang.String connectorBindingName) Start the Connector Binding by the name given, if it is already added and not srarted.
void	stopConnectorBinding(java.lang.String connectorBindingName) Stop the Connector Binding by the given name

Methods inherited from interface com.metamatrix.common.application.ApplicationService

initialize, start, stop

Method Detail

selectConnector

com.metamatrix.dqp.internal.datamgr.ConnectorID selectConnector(java.lang.String connectorBindingName)
                                                                throws MetaMatrixComponentException

Select a connector to use for the given connector binding.

Parameters:

connectorBindingName - Connector binding identifier

Returns:

ConnectorID identifying a connector instance

Throws:

MetaMatrixComponentException

executeRequest

void executeRequest(AtomicRequestMessage request,
                    com.metamatrix.dqp.internal.datamgr.ConnectorID connector,
                    ResultsReceiver<AtomicResultsMessage> resultListener)
                    throws MetaMatrixComponentException

Execute the given request on a Connector.

Parameters:

request -

Throws:

MetaMatrixComponentException

cancelRequest

void cancelRequest(AtomicRequestID request,
                   com.metamatrix.dqp.internal.datamgr.ConnectorID connectorId)
                   throws MetaMatrixComponentException

Throws:

MetaMatrixComponentException

closeRequest

void closeRequest(AtomicRequestID request,
                  com.metamatrix.dqp.internal.datamgr.ConnectorID connectorId)
                  throws MetaMatrixComponentException

Throws:

MetaMatrixComponentException

requestBatch

void requestBatch(AtomicRequestID request,
                  com.metamatrix.dqp.internal.datamgr.ConnectorID connectorId)
                  throws MetaMatrixComponentException

Throws:

MetaMatrixComponentException

getCapabilities

SourceCapabilities getCapabilities(RequestMessage request,
                                   org.teiid.dqp.internal.process.DQPWorkContext dqpWorkContext,
                                   com.metamatrix.dqp.internal.datamgr.ConnectorID connector)
                                   throws MetaMatrixComponentException

Find the capabilities of this source.

Parameters:

request - Original request message, used to extract security information

connector - Connector to retrieve capabilities from

Returns:

All capability information as key-value pairs

Throws:

MetaMatrixComponentException

getConnectorMetadata

ConnectorMetadata getConnectorMetadata(java.lang.String vdbName,
                                       java.lang.String vdbVersion,
                                       java.lang.String modelName,
                                       java.util.Properties importProperties)
                                       throws MetaMatrixComponentException

Return the metadata for a given connector

Parameters:

vdbName -

vdbVersion -

modelName -

importProperties -

Returns:

Throws:

MetaMatrixComponentException

startConnectorBinding

void startConnectorBinding(java.lang.String connectorBindingName)
                           throws ApplicationLifecycleException,
                                  MetaMatrixComponentException

Start the Connector Binding by the name given, if it is already added and not srarted.

Parameters:

connectorBindingName -

Throws:

ApplicationLifecycleException

ComponentNotFoundException

MetaMatrixComponentException

Since:

4.3

stopConnectorBinding

void stopConnectorBinding(java.lang.String connectorBindingName)
                          throws ApplicationLifecycleException,
                                 MetaMatrixComponentException

Stop the Connector Binding by the given name

Parameters:

connectorBindingName -

Throws:

ApplicationLifecycleException

ComponentNotFoundException

MetaMatrixComponentException

Since:

4.3

getConnectorBindings

java.util.List getConnectorBindings()
                                    throws MetaMatrixComponentException

Get the list of connector bindings deployed in the system.

Returns:

list ConnectorBinding

Throws:

ComponentNotFoundException

MetaMatrixComponentException

Since:

4.3

getConnectorBinding

ConnectorBinding getConnectorBinding(java.lang.String connectorBindingName)
                                     throws MetaMatrixComponentException

Get the connector binding specifed the name

Returns:

ConnectorBinding

Throws:

ComponentNotFoundException

MetaMatrixComponentException

Since:

4.3

getConnectorBindingState

ConnectorStatus getConnectorBindingState(java.lang.String connectorBindingName)
                                         throws MetaMatrixComponentException

Get the State of the connector binding name

Returns:

ConnectorStatus

Throws:

MetaMatrixComponentException

Since:

4.3

getConnectorBindingStatistics

java.util.Collection getConnectorBindingStatistics(java.lang.String connectorBindingName)
                                                   throws MetaMatrixComponentException

Get connector bindings queue statistics

Parameters:

connectorBindingName - - Name of the connector binding

Returns:

a list of WorkerPoolStats

Throws:

MetaMatrixComponentException

Since:

4.3

clearConnectorBindingCache

void clearConnectorBindingCache(java.lang.String connectorBindingName)
                                throws MetaMatrixComponentException

Clear any caches for the connector binding. Incase of the JDBC Connector clear the result set cache.

Parameters:

connectorBindingName -

Throws:

MetaMatrixComponentException

Since:

4.3

getConnectionPoolStatistics

java.util.Collection<? extends ConnectionPool> getConnectionPoolStatistics(java.lang.String connectorBindingName)
                                                                           throws MetaMatrixComponentException

Get connection pool statistics for connector binding

Parameters:

connectorBindingName - - Name of the connector binding

Returns:

a list of com.metamatrix.admin.objects.ConnectionPoolStatsImpl

Throws:

MetaMatrixComponentException

Since:

6.1