oracle.ifs.protocols.utils

Class OfficeSaveDetector

java.lang.Object

oracle.ifs.protocols.utils.OfficeSaveDetector

public class OfficeSaveDetector
extends Object

This class attempts to detect the behavior of MS Office when it saves over an existing file. An example of such behavior is Word95, which creates a new file (newfile.tmp), renames the original file (original.doc) to another filename (original.tmp), then renames newfile.tmp to be original.doc. After this succeeds, it deletes original.tmp. This causes a problem with custom attributes, because they will disappear during an Office Save. So here's a hacked up solution. The proper use of this class is: 1) Create a new OfficeSaveDetector for each session. (We'll call it osd) 2) Any time your server wants to delete a file, call osd.deleteDoc() 3) Any time your server wants to move/rename a file, do this: Document doc = osd.detectOnMove(...) if(doc == null) { doc = whateverYouNormallyDoToMoveADocument(...); // the next line should only be called after a successful move osd.completeMove(...); } 4) Any time your server wants to create a new file, do this: Document doc = osd.detectOnCreate(...) if(doc == null) { doc = whateverYouNormallyDoToCreateADocument(...); } 5) Before you close the session, call osd.cleanUp();

Constructor Summary

Constructors

Constructor and Description
OfficeSaveDetector()

Method Summary

Modifier and Type	Method and Description
void	cleanUp() This function forces the detector to free documents that were unfoldered but left lying around in the database by a call to deleteDoc().
void	completeMove(LibrarySession sess, PublicObject po, Folder from, String fromName) This function notifies this detector that a successful move has been completed.
void	deleteDoc(LibrarySession sess, Document doc, Folder folder, boolean freeIfLast) This function pretends to delete the given document.
Document	detectOnCreate(LibrarySession sess, DocumentDefinition def, String name, Folder f) This function attempts to detect an edit in place.
Document	detectOnMove(LibrarySession sess, PublicObject po, Folder from, Folder to, String toName) This function attempts to detect an Office save on a move.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OfficeSaveDetector

public OfficeSaveDetector()

Method Detail

detectOnCreate

public Document detectOnCreate(LibrarySession sess,
                               DocumentDefinition def,
                               String name,
                               Folder f)

This function attempts to detect an edit in place. If one is detected, then this function will return a recycled Document that has been updated with the given def. Because it's a recycled document, you want to set a bunch of things in the provided DocDef. 1) EmptyContent: If you want the document to have empty content, then you *must* specify that in the given DocumentDefinition. 2) Name: the name of the document must be specified in the given DocDef. 3) AddToFolderOption: if you want this function to add the document to the given Folder, you must specify that in the def as well.

completeMove

public void completeMove(LibrarySession sess,
                         PublicObject po,
                         Folder from,
                         String fromName)

This function notifies this detector that a successful move has been completed.

detectOnMove

public Document detectOnMove(LibrarySession sess,
                             PublicObject po,
                             Folder from,
                             Folder to,
                             String toName)

This function attempts to detect an Office save on a move. If a save is detected, then this function will folder a recycled document in the "to" folder with the given "toName". The content of this document will be set to the content of the given po. The given PO will be deleted (and freed if last folder reference). Finally, the new document will be returned. If a move is not detected or an error occurs, this function will return null.

deleteDoc

public void deleteDoc(LibrarySession sess,
                      Document doc,
                      Folder folder,
                      boolean freeIfLast)
               throws IfsException

This function pretends to delete the given document. It really just unfolders it and stores it for later use if a save is detected. Later, the document will be freed if freeIfLast is true and it's the last folder reference.

Throws:

IfsException

cleanUp

public void cleanUp()

This function forces the detector to free documents that were unfoldered but left lying around in the database by a call to deleteDoc(). Really this function should be called whenever you're done using this OfficeSaveDetector.