oracle.alm.connector
Interface DocumentConnector

public interface DocumentConnector

The DocumentConnector interface is implemented by a document connector to
show documents in the Documents accordion of Oracle Team Productivity Center (OTPC)
Team Navigator. It provides access to backend repository that stores the documents.
OTPC document framework display these documents in either flat or hierarchical layout.
To implement the document connector, document writer needs to implement login() using
the connector parameters passed in the session map to connect to its document backend
server. Information such as cookie, which needs to be maintained or passed
around between connector calls, can be added to the session map. The document framework
maintains information stored in the session map throughout the entire connector's lifecycle.

init

Initializes the connector instance on the client side in a state specified by the connector
parameters. These parameters are defined in the connector.xml file, and typically include the
connector's physical connection parameters for corresponding repository.

login

Establishes a user connection between the connector instance on the client side and
the backend repository. If login is successful, connector writer may add connection cookie
to the session context for later use.

Parameters:

session - user session context

userName - the Id used to access the backend repository. It will never be null

password - the password used to access the backend repository. It may be null

logout

Disconnects the user session from the backend repository. If session cookie is also stored inside the session context,
it can be used to log out from the backend repository. State can be saved inside the session map.