com.metamatrix.connector.xml.base
Class XMLConnector

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

All Implemented Interfaces:

CachingConnector, StatefulConnector, Connector

public class XMLConnector
extends AbstractCachingConnector

Field Summary

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

m_environment, m_logger, m_state

Constructor Summary

XMLConnector()

Method Summary

ConnectorCapabilities	getCapabilities() Get the capabilities of this connector.
Connection	getConnection(ExecutionContext context) Obtain a connection with the connector.
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.StatefulConnector

getEnvironment, getLogger, getState

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

createIdentity

Constructor Detail

XMLConnector

public XMLConnector()

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 AbstractCachingConnector

Parameters:

env - The connector environment, provided by the Connector Manager

Throws:

ConnectorException

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

Overrides:

stop in class AbstractCachingConnector

getConnection

public Connection getConnection(ExecutionContext context)
                         throws ConnectorException

Description copied from interface: Connector

Obtain a connection with the connector. The connection typically is associated with a particular security context. The connection is assumed to be pooled in the underlying source if pooling is necessary - the connection will be closed when execution has completed against it.

Parameters:

context - The context of the current user that will be using this connection, may be null if this connection is for an administrative operation.

Returns:

A Connection, created by the Connector

Throws:

ConnectorException - If an error occurred obtaining a connection

getCapabilities

public ConnectorCapabilities getCapabilities()

Description copied from interface: Connector

Get the capabilities of this connector. The capabilities affect what kinds of queries (and other commands) will be sent to the connector.

Returns:

ConnectorCapabilities, may return null if the Connector provides User scoped capabilities Connection.getCapabilities()