com.metamatrix.connector.xml
Class AbstractCachingConnector

java.lang.Object
  org.teiid.connector.basic.BasicConnector
      com.metamatrix.connector.xml.base.LoggingConnector
          com.metamatrix.connector.xml.AbstractCachingConnector

All Implemented Interfaces:

StatefulConnector, CachingConnector, Connector

Direct Known Subclasses:

XMLConnector

public abstract class AbstractCachingConnector
extends LoggingConnector
implements CachingConnector

Field Summary

Fields inherited from class com.metamatrix.connector.xml.base.LoggingConnector

m_state

Constructor Summary

AbstractCachingConnector()

Method Summary

void	createCacheObjectRecord(java.lang.String requestID, java.lang.String partID, java.lang.String executionID, java.lang.String sourceRequestID, java.lang.String cacheKey)
void	deleteCacheItems(java.lang.String requestID, java.lang.String partID, java.lang.String executionID)
IDocumentCache	getCache()
IDocumentCache	getStatementCache()
void	start(ConnectorEnvironment env) Start the connector with the connector environment.
void	stop() Stop the connector.

Methods inherited from class com.metamatrix.connector.xml.base.LoggingConnector

getEnvironment, getLogger, getState

Methods inherited from class org.teiid.connector.basic.BasicConnector

areAdminConnectionsAllowed, createIdentity, getConnectorName, setAdminConnectionsAllowed, setConnectorName, setUseCredentialMap, useCredentialMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.metamatrix.connector.xml.base.StatefulConnector

getEnvironment, getLogger, getState

Methods inherited from interface org.teiid.connector.api.Connector

createIdentity, getCapabilities, getConnection

Constructor Detail

AbstractCachingConnector

public AbstractCachingConnector()

Method Detail

start

public void start(ConnectorEnvironment env)
           throws ConnectorException

Description copied from interface: Connector

Start the connector with the connector environment. The environment provides access to external resources the connector implementation may need to use.

Specified by:

start in interface Connector

Overrides:

start in class LoggingConnector

Parameters:

env - The connector environment, provided by the Connector Manager

Throws:

ConnectorException

getCache

public IDocumentCache getCache()

Specified by:

getCache in interface CachingConnector

getStatementCache

public IDocumentCache getStatementCache()

Specified by:

getStatementCache in interface CachingConnector

stop

public void stop()

Description copied from interface: Connector

Stop the connector. No commands will be executed on the connector when it is stopped.

Specified by:

stop in interface Connector

createCacheObjectRecord

public void createCacheObjectRecord(java.lang.String requestID,
                                    java.lang.String partID,
                                    java.lang.String executionID,
                                    java.lang.String sourceRequestID,
                                    java.lang.String cacheKey)
                             throws ConnectorException

Specified by:

createCacheObjectRecord in interface CachingConnector

Throws:

ConnectorException

deleteCacheItems

public void deleteCacheItems(java.lang.String requestID,
                             java.lang.String partID,
                             java.lang.String executionID)

Specified by:

deleteCacheItems in interface CachingConnector