org.apache.manifoldcf.crawler.common.DCTM

Interface IDocumentum

All Superinterfaces:

java.rmi.Remote

public interface IDocumentum
extends java.rmi.Remote

This class abstracts away from the documentum methods necessary to "do things" that the crawler or authority needs to be done with the Documentum repository. The purpose for breaking this out is to permit the Documentum invocation to be RMI based, because it keeps segfaulting on us. One of the tricks needed is to preserve session. This is handled at this level by explicitly passing a session string around. The session string is created on the remote JVM, and is subsequently used to describe the individual session we care about from the client side.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	_rcsid

Method Summary

Modifier and Type	Method and Description
java.lang.String	buildDateString(long timestamp) Build a DQL date string from a long timestamp
void	checkConnection() Check if there is a working connection.
void	createSession(java.lang.String docbaseName, java.lang.String userName, java.lang.String password, java.lang.String domain) Create a session.
void	destroySession() Delete the session.
java.lang.String	getDocbaseName() Read the docbase name based on the session.
IDocumentumResult	getFolderContents(java.lang.String folderPath) Get folder contents
IDocumentumObject	getObjectByQualification(java.lang.String dql) Get a documentum object, by qualification.
java.lang.String	getServerVersion() Get the server version.
java.lang.String	getSessionId() Get the current session id.
boolean	isOneOf(java.lang.String theType, java.lang.String[] matchTypeSet) Check if an object type is equal to or is a subtype of any one of a set of other object types.
IDocumentumResult	performDQLQuery(java.lang.String dql) Perform a DQL query.

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

Method Detail

createSession

void createSession(java.lang.String docbaseName,
                   java.lang.String userName,
                   java.lang.String password,
                   java.lang.String domain)
            throws DocumentumException,
                   java.rmi.RemoteException

Create a session.

Parameters:

docbaseName - is the name of the docbase we want to connect to.

userName - is the username to use to establish the session.

password - is the password to use to establish the session.

domain - is the domain to use to establish the session.

Throws:

DocumentumException

java.rmi.RemoteException

destroySession

void destroySession()
             throws DocumentumException,
                    java.rmi.RemoteException

Delete the session.

Throws:

DocumentumException

java.rmi.RemoteException

checkConnection

void checkConnection()
              throws DocumentumException,
                     java.rmi.RemoteException

Check if there is a working connection.

Throws:

DocumentumException

java.rmi.RemoteException

getDocbaseName

java.lang.String getDocbaseName()
                         throws DocumentumException,
                                java.rmi.RemoteException

Read the docbase name based on the session.

Throws:

DocumentumException

java.rmi.RemoteException

getServerVersion

java.lang.String getServerVersion()
                           throws DocumentumException,
                                  java.rmi.RemoteException

Get the server version.

Throws:

DocumentumException

java.rmi.RemoteException

getSessionId

java.lang.String getSessionId()
                       throws DocumentumException,
                              java.rmi.RemoteException

Get the current session id.

Throws:

DocumentumException

java.rmi.RemoteException

performDQLQuery

IDocumentumResult performDQLQuery(java.lang.String dql)
                           throws DocumentumException,
                                  java.rmi.RemoteException

Perform a DQL query. What comes back from this is the equivalent of a DFC collection, which I've represented as an interface that reads a resultset-like object in a streamed manner.

Parameters:

dql - is the query that is to be fired off.

Returns:

a resultset. This differs somewhat from the documentum convention in that it is ALWAYS returned, even if it is empty.

Throws:

DocumentumException

java.rmi.RemoteException

getObjectByQualification

IDocumentumObject getObjectByQualification(java.lang.String dql)
                                    throws DocumentumException,
                                           java.rmi.RemoteException

Get a documentum object, by qualification. The qualification is a DQL query part. The returned object has properties as described by the methods of IDocumentumObject.

Throws:

DocumentumException

java.rmi.RemoteException

getFolderContents

IDocumentumResult getFolderContents(java.lang.String folderPath)
                             throws DocumentumException,
                                    java.rmi.RemoteException

Get folder contents

Throws:

DocumentumException

java.rmi.RemoteException

isOneOf

boolean isOneOf(java.lang.String theType,
                java.lang.String[] matchTypeSet)
         throws DocumentumException,
                java.rmi.RemoteException

Check if an object type is equal to or is a subtype of any one of a set of other object types.

Throws:

DocumentumException

java.rmi.RemoteException

buildDateString

java.lang.String buildDateString(long timestamp)
                          throws java.rmi.RemoteException

Build a DQL date string from a long timestamp

Throws:

java.rmi.RemoteException