|
Oracle Fusion Middleware Java API Reference for Oracle Team Productivity Center 11g Release 2 (11.1.2.2.0) E17494-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.
Method Summary | |
---|---|
DocumentItem |
createDocumentItem(java.util.Map session, DocumentItem item) Creates a document item on the document repository. |
void |
deleteDocumentItem(java.util.Map session, DocumentItem item) Deletes a document item from the document repository. |
void |
downloadDocumentFile(java.util.Map session, DocumentItem item, java.lang.String localPath) Downloads a document file to the specified local pathname. |
java.util.List<DocumentItem> |
getContent(java.util.Map session, java.lang.String itemKey) Get list of document items from specified path on the document repository. |
java.lang.String |
getDocumentRootPath(java.util.Map session) Returns the root path of the document repository. |
void |
init(java.util.Map session) Initializes the connector instance on the client side in a state specified by the connector parameters. |
void |
login(java.util.Map session, java.lang.String userName, java.lang.String password) Establishes a user connection between the connector instance on the client side and the backend repository. |
void |
logout(java.util.Map session) Disconnects the user session from the backend repository. |
DocumentItem |
updateDocumentItem(java.util.Map session, DocumentItem oldItem, DocumentItem newItem) Updates attributes of a document item on the document repository. |
DocumentItem |
uploadDocumentFile(java.util.Map session, DocumentItem item, java.lang.String localPath) Uploads a local file to a document repository. |
Method Detail |
---|
void init(java.util.Map session) throws ALMException
session
- initial connector parameters as specified by its corresponding repositoryALMException
- if required repository information is missingvoid login(java.util.Map session, java.lang.String userName, java.lang.String password) throws ALMException
session
- user session contextuserName
- the Id used to access the backend repository. It will never be nullpassword
- the password used to access the backend repository. It may be nullALMException
- if failed to log in.void logout(java.util.Map session) throws ALMException
session
- user session contextALMException
- if failed to log off.java.util.List<DocumentItem> getContent(java.util.Map session, java.lang.String itemKey) throws ALMException
session
- user session contextitemKey
- the relative path from the root path in the document repository.ALMException
- if failed to get the document list from the specified path.DocumentItem createDocumentItem(java.util.Map session, DocumentItem item) throws ALMException
session
- user session contextitem
- document folder to createALMException
- if failed to create the document folder item.void deleteDocumentItem(java.util.Map session, DocumentItem item) throws ALMException
session
- user session contextitem
- document item to deleteALMException
- if failed to delete the document item.DocumentItem updateDocumentItem(java.util.Map session, DocumentItem oldItem, DocumentItem newItem) throws ALMException
session
- user session contextoldItem
- old document itemnewItem
- new document itemALMException
- if failed to update the document item.void downloadDocumentFile(java.util.Map session, DocumentItem item, java.lang.String localPath) throws ALMException
session
- user session contextitem
- document file to downloadlocalPath
- local pathname to download the document toALMException
- if failed to download the document fileDocumentItem uploadDocumentFile(java.util.Map session, DocumentItem item, java.lang.String localPath) throws ALMException
session
- user session contextitem
- document item to createlocalPath
- local pathname to upload the file fromALMException
- if failed to upload the document file.java.lang.String getDocumentRootPath(java.util.Map session)
session
- user session context
|
Oracle Fusion Middleware Java API Reference for Oracle Team Productivity Center 11g Release 2 (11.1.2.2.0) E17494-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |