|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Connector
The primary entry point for a Connector. This interface should be implemented by the connector writer.
The Connector Manager will instantiate the implementation
of this class by reflection in an isolated classloader. Once the class has been
instantiated, the #initialize(ConnectorEnvironment)
method will be called
with all necessary connector properties. The #start()
and stop()
methods are lifecycle methods called when starting or stopping the connector.
Method Summary | |
---|---|
ConnectorIdentity |
createIdentity(ExecutionContext context)
Create an identity object based on a security context. |
ConnectorCapabilities |
getCapabilities()
Get the capabilities of this connector. |
Connection |
getConnection(ExecutionContext context)
Obtain a connection with the connector. |
void |
start(ConnectorEnvironment environment)
Start the connector with the connector environment. |
void |
stop()
Stop the connector. |
Method Detail |
---|
void start(ConnectorEnvironment environment) throws ConnectorException
environment
- The connector environment, provided by the Connector Manager
ConnectorException
void stop()
Connection getConnection(ExecutionContext context) throws ConnectorException
context
- The context of the current user that will be using this connection,
may be null if this connection is for an administrative operation.
ConnectorException
- If an error occurred obtaining a connectionConnectorCapabilities getCapabilities()
Connection.getCapabilities()
ConnectorIdentity createIdentity(ExecutionContext context) throws ConnectorException
ConnectorIdentity
interface to similarly affect pooling.
context
- The context provided by the Connector Manager
ConnectorException
- If a null context is not accepted or an error occurs while creating the identity.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |