org.apache.manifoldcf.crawler.common.filenet

Interface IFilenet

All Superinterfaces:

java.rmi.Remote

public interface IFilenet
extends java.rmi.Remote

This class abstracts away from the filenet methods necessary to "do things" that the crawler or authority needs to be done with the Filenet repository. The purpose for breaking this out is to permit the Filenet invocation to be RMI based, because it relies on too many specific versions of jars. 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
void	checkConnection() Check if there is a working connection.
void	createSession(java.lang.String userID, java.lang.String password, java.lang.String domain, java.lang.String objectStore, java.lang.String serverWSIURI) Create a session.
void	destroySession() Delete a session.
java.lang.String[]	getChildFolders(java.lang.String[] parentFolderPath) Get the set of folder names that are children of the specified folder path.
DocumentClassDefinition[]	getDocumentClassesDetails() Get the set of available document classes
MetadataFieldDefinition[]	getDocumentClassMetadataFieldsDetails(java.lang.String documentClassName) Get the set of available metadata fields per document class
java.lang.Integer	getDocumentContentCount(java.lang.String docId) Get the document content information given an object id.
void	getDocumentContents(java.lang.String docId, int elementNumber, java.lang.String tempFileName) Get document contents
FileInfo	getDocumentInformation(java.lang.String docId, java.util.Map<java.lang.String,java.lang.Object> metadataFields) Get document information for a given filenet document.
java.lang.String[]	getMatchingObjectIds(java.lang.String sql) Execute a sql statement against FileNet and return the matching object id's

Field Detail

_rcsid

static final java.lang.String _rcsid

See Also:

Constant Field Values

Method Detail

createSession

void createSession(java.lang.String userID,
                   java.lang.String password,
                   java.lang.String domain,
                   java.lang.String objectStore,
                   java.lang.String serverWSIURI)
            throws FilenetException,
                   java.rmi.RemoteException

Create a session.

Parameters:

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

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

domain - is the filenet domain of the user and password.

objectStore - is the object store to use to establish the session.

serverWSIURI - is the URI to use to get to the server's web services.

Throws:

FilenetException

java.rmi.RemoteException

destroySession

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

Delete a session.

Throws:

FilenetException

java.rmi.RemoteException

checkConnection

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

Check if there is a working connection.

Throws:

FilenetException

java.rmi.RemoteException

getChildFolders

java.lang.String[] getChildFolders(java.lang.String[] parentFolderPath)
                            throws FilenetException,
                                   java.rmi.RemoteException

Get the set of folder names that are children of the specified folder path.

Throws:

FilenetException

java.rmi.RemoteException

getDocumentClassesDetails

DocumentClassDefinition[] getDocumentClassesDetails()
                                             throws FilenetException,
                                                    java.rmi.RemoteException

Get the set of available document classes

Throws:

FilenetException

java.rmi.RemoteException

getDocumentClassMetadataFieldsDetails

MetadataFieldDefinition[] getDocumentClassMetadataFieldsDetails(java.lang.String documentClassName)
                                                         throws FilenetException,
                                                                java.rmi.RemoteException

Get the set of available metadata fields per document class

Throws:

FilenetException

java.rmi.RemoteException

getMatchingObjectIds

java.lang.String[] getMatchingObjectIds(java.lang.String sql)
                                 throws java.rmi.RemoteException,
                                        FilenetException

Execute a sql statement against FileNet and return the matching object id's

Throws:

java.rmi.RemoteException

FilenetException

getDocumentContentCount

java.lang.Integer getDocumentContentCount(java.lang.String docId)
                                   throws java.rmi.RemoteException,
                                          FilenetException

Get the document content information given an object id. Will return null if the version id is not a current document version id.

Throws:

java.rmi.RemoteException

FilenetException

getDocumentInformation

FileInfo getDocumentInformation(java.lang.String docId,
                                java.util.Map<java.lang.String,java.lang.Object> metadataFields)
                         throws FilenetException,
                                java.rmi.RemoteException

Get document information for a given filenet document. Will return null if the version id is not a current document version id. The metadataFields hashmap is keyed by document class, and contains as a value either null (meaning "all"), or a String[] that has the list of fields desired.

Throws:

FilenetException

java.rmi.RemoteException

getDocumentContents

void getDocumentContents(java.lang.String docId,
                         int elementNumber,
                         java.lang.String tempFileName)
                  throws FilenetException,
                         java.rmi.RemoteException

Get document contents

Throws:

FilenetException

java.rmi.RemoteException