Point checkin.

Augmented AVMRemote to expose lookup that can fetch deleted nodes.
Minor fixup to excluder regex in avm-services-context.xml.
Added excluder to LinkValidationServiceImpl.
Prep to walk difference using SyncService (getting ready for incremental update of link validation tables).


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5898 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

config/alfresco/avm-services-context.xml

@@ -249,12 +249,14 @@
           class="org.alfresco.repo.avm.wf.AVMSubmitTransactionListener"/>
 
 
-	<!-- NameMatcher beans for filtering what shows up as different in compares. -->
+    <!-- NameMatcher beans for filtering what shows up as different in compares. -->
-	
     <bean id="excludeRegexMatcher" class="org.alfresco.util.RegexNameMatcher">
         <property name="patterns">        
+            <!-- 
+            NOTE:  Regexes are implicitly anchored with ^ and $ in this context.
+            -->
             <list>
-            	<value>.*/#.*</value>
+            	<value>.*/#[^/]*</value>    <!-- A leaf starting with '#' -->
             </list>
         </property>
     </bean>

source/java/org/alfresco/linkvalidation/HrefValidationProgress.java

@@ -22,7 +22,7 @@
 *  
 *  
 *  Author  Jon Cox  <jcox@alfresco.com>
-*  File    UpdateHrefInfoStatus.java
+*  File    HrefValidationProgress.java
 *----------------------------------------------------------------------------*/
 
 package org.alfresco.linkvalidation;
@@ -43,10 +43,10 @@ import java.util.concurrent.atomic.AtomicBoolean;
 *  call to updateHrefInfo() has completed by examining
 *  the value returned by isDone().
 *  <p>
-*  Note:  It is safest to instantiate a fresh UpdateHrefInfoStatus 
+*  Note:  It is safest to instantiate a fresh HrefValidationProgress 
 *  object for every invocation of updateHrefInfo().
 */
-public class UpdateHrefInfoStatus
+public class HrefValidationProgress
 {
     AtomicInteger webapp_update_count_;
     AtomicInteger dir_update_count_;
@@ -54,7 +54,7 @@ public class UpdateHrefInfoStatus
     AtomicInteger url_update_count_;
     AtomicBoolean is_done_;
 
-    public UpdateHrefInfoStatus() 
+    public HrefValidationProgress() 
     {
         webapp_update_count_ = new AtomicInteger();
         dir_update_count_    = new AtomicInteger();

source/java/org/alfresco/linkvalidation/LinkValidationService.java

@@ -66,12 +66,12 @@ public interface LinkValidationService
     *             'status' may be polled in a separate thread to 
     *             observe its progress.
     */
-    public void updateHrefInfo( String  storeNameOrWebappPath,
+    public void updateHrefInfo( String   storeNameOrWebappPath,
-                                boolean incremental,
+                                boolean  incremental,
-                                int     connectTimeout,
+                                int      connectTimeout,
-                                int     readTimeout,
+                                int      readTimeout,
-                                int     nthreads,
+                                int      nthreads,
-                                UpdateHrefInfoStatus status
+                                HrefValidationProgress progress
                               ) 
                 throws AVMNotFoundException;
 
@@ -208,9 +208,11 @@ public interface LinkValidationService
     *  Don't use yet - does nothing at the moment.
     */
     public BrokenHrefConcordanceDifference getBrokenHrefConcordanceDifference(
-                                               int srcVersion, String srcPath,
+                                               int         srcVersion, 
-                                               int dstVersion, String dstPath,
+                                               String      srcPath,
-                                               NameMatcher     excluder) 
+                                               int         dstVersion, 
+                                               String      dstPath,
+                                               HrefValidationProgress progress)
                                            throws AVMNotFoundException;
 }
 

source/java/org/alfresco/repo/avm/AVMRemoteLocal.java

@@ -317,6 +317,14 @@ public class AVMRemoteLocal implements AVMRemote
         return fService.lookup(version, path);
     }
 
+    /* (non-Javadoc)
+     * @see org.alfresco.repo.avm.AVMRemote#lookup(int, java.lang.String, boolean)
+     */
+    public AVMNodeDescriptor lookup(int version, String path, boolean includeDeleted) 
+    {
+        return fService.lookup(version, path, includeDeleted);
+    }
+
     /* (non-Javadoc)
      * @see org.alfresco.repo.avm.AVMRemote#lookup(org.alfresco.service.cmr.avm.AVMNodeDescriptor, java.lang.String)
      */
@@ -325,6 +333,14 @@ public class AVMRemoteLocal implements AVMRemote
         return fService.lookup(dir, name);
     }
 
+    /* (non-Javadoc)
+     * @see org.alfresco.repo.avm.AVMRemote#lookup(org.alfresco.service.cmr.avm.AVMNodeDescriptor, java.lang.String, boolean includeDeleted)
+     */
+    public AVMNodeDescriptor lookup(AVMNodeDescriptor dir, String name, boolean includeDeleted) 
+    {
+        return fService.lookup(dir, name, includeDeleted);
+    }
+
     /* (non-Javadoc)
      * @see org.alfresco.repo.avm.AVMRemote#makePrimary(java.lang.String)
      */

source/java/org/alfresco/repo/avm/AVMRemoteTransportService.java

@@ -705,6 +705,23 @@ public class AVMRemoteTransportService implements AVMRemoteTransport, Runnable
         return fAVMService.lookup(version, path);
     }
 
+    /**
+     * Lookup a node identified by version ID and path; optionally,
+     * if the node is deleted, its descriptor can still
+     * be retrieved. 
+     *
+     * @param version        The version ID to look under.
+     * @param path           The simple absolute path to the parent directory.
+     * @param includeDeleted Whether to allow a deleted node to be retrieved
+     * @return               An AVMNodeDescriptor, or null if the version does not exist.
+     */
+    public AVMNodeDescriptor lookup(String ticket, int version, String path, boolean includeDeleted) 
+    {
+        fAuthService.validate(ticket);
+        return fAVMService.lookup(version, path, includeDeleted);
+    }
+
+    
     /**
      * Get a descriptor for the specified node.
      * @param dir The descriptor for the directory node.
@@ -717,6 +734,25 @@ public class AVMRemoteTransportService implements AVMRemoteTransport, Runnable
         return fAVMService.lookup(dir, name);
     }
 
+    /**
+     * Lookup a node identified by the directory that contains it, and its name;
+     * optionally, the lookup can retrive the descriptor of a node even if 
+     * it has been deleted from its containing directory.
+     *
+     * @param dir            The descriptor for the directory node.
+     * @param name           The name to lookup.
+     * @param includeDeleted Whether to allow a deleted node to be retrieved via the lookup
+     * @return               The descriptor for the child, null if the child doesn't exist.
+     * @throws               AVMNotFoundException
+     * @throws               AVMWrongTypeException
+     */
+    public AVMNodeDescriptor lookup(String ticket, AVMNodeDescriptor dir, String name, boolean includeDeleted) 
+    {
+        fAuthService.validate(ticket);
+        return fAVMService.lookup(dir, name, includeDeleted);
+    }
+
+    
     /**
      * Get the indirection path for a node.
      * @param version The version to look under.

source/java/org/alfresco/repo/remote/AVMRemoteImpl.java

@@ -331,6 +331,15 @@ public class AVMRemoteImpl implements AVMRemote
         return fTransport.lookup(fTicketHolder.getTicket(), version, path);
     }
 
+    /* (non-Javadoc)
+     * @see org.alfresco.repo.avm.AVMRemote#lookup(int, java.lang.String, boolean)
+     */
+    public AVMNodeDescriptor lookup(int version, String path, boolean includeDeleted) 
+    {
+        return fTransport.lookup(fTicketHolder.getTicket(), version, path, includeDeleted);
+    }
+
+
     /* (non-Javadoc)
      * @see org.alfresco.repo.avm.AVMRemote#lookup(org.alfresco.service.cmr.avm.AVMNodeDescriptor, java.lang.String)
      */
@@ -339,6 +348,15 @@ public class AVMRemoteImpl implements AVMRemote
         return fTransport.lookup(fTicketHolder.getTicket(), dir, name);
     }
 
+    /* (non-Javadoc)
+     * @see org.alfresco.repo.avm.AVMRemote#lookup(org.alfresco.service.cmr.avm.AVMNodeDescriptor, java.lang.String, boolean includeDeleted)
+     */
+    public AVMNodeDescriptor lookup(AVMNodeDescriptor dir, String name, boolean includeDeleted) 
+    {
+        return fTransport.lookup(fTicketHolder.getTicket(), dir, name, includeDeleted);
+    }
+
+
     /* (non-Javadoc)
      * @see org.alfresco.repo.avm.AVMRemote#makePrimary(java.lang.String)
      */

source/java/org/alfresco/service/cmr/avm/AVMNodeDescriptor.java

@@ -253,6 +253,11 @@ public class AVMNodeDescriptor implements Serializable
     /**
      * Determines whether this node corresponds to
      * either a plain or layered file.   
+     * <p>
+     * NOTE:  A deleted file node is <em>not</em> considered a file 
+     * (i.e.: isFile() returns false when isDeleted() returns true).  
+     * Therefore, use isDeletedFile() to determine if a deleted node 
+     * was a file, not isFile().
      *
      * @return true if AVMNodeDescriptor is a plain or layered file,
      *         otherwise false.
@@ -290,6 +295,11 @@ public class AVMNodeDescriptor implements Serializable
     /**
      * Determines whether this node corresponds to
      * either a plain or layered directory. 
+     * <p>
+     * NOTE:  A deleted directory node is <em>not</em> considered a directory 
+     * (i.e.: isDirectory() returns false when isDeleted() returns true).  
+     * Therefore, use isDeletedDirectory() to determine if a deleted node 
+     * was a directory, not isDirectory().
      *
      * @return true if AVMNodeDescriptor is a plain or layered directory,
      *         otherwise false.

source/java/org/alfresco/service/cmr/remote/AVMRemote.java

@@ -245,6 +245,18 @@ public interface AVMRemote
      */
     public AVMNodeDescriptor lookup(int version, String path);
 
+    /**
+     * Lookup a node identified by version ID and path; optionally,
+     * if the node is deleted, its descriptor can still
+     * be retrieved. 
+     *
+     * @param version        The version ID to look under.
+     * @param path           The simple absolute path to the parent directory.
+     * @param includeDeleted Whether to allow a deleted node to be retrieved
+     * @return               An AVMNodeDescriptor, or null if the version does not exist.
+     */
+    public AVMNodeDescriptor lookup(int version, String path, boolean includeDeleted);
+    
     /**
      * Get a descriptor for the specified node.
      * @param dir The descriptor for the directory node.
@@ -253,6 +265,20 @@ public interface AVMRemote
      */
     public AVMNodeDescriptor lookup(AVMNodeDescriptor dir, String name);
 
+    /**
+     * Lookup a node identified by the directory that contains it, and its name;
+     * optionally, the lookup can retrive the descriptor of a node even if 
+     * it has been deleted from its containing directory.
+     *
+     * @param dir            The descriptor for the directory node.
+     * @param name           The name to lookup.
+     * @param includeDeleted Whether to allow a deleted node to be retrieved via the lookup
+     * @return               The descriptor for the child, null if the child doesn't exist.
+     * @throws               AVMNotFoundException
+     * @throws               AVMWrongTypeException
+     */
+    public AVMNodeDescriptor lookup(AVMNodeDescriptor dir, String name, boolean includeDeleted);
+    
     /**
      * Get the indirection path for a node.
      * @param version The version to look under.

source/java/org/alfresco/service/cmr/remote/AVMRemoteTransport.java

@@ -257,6 +257,19 @@ public interface AVMRemoteTransport
      */
     public AVMNodeDescriptor lookup(String ticket, int version, String path);
 
+    /**
+     * Lookup a node identified by version ID and path; optionally,
+     * if the node is deleted, its descriptor can still
+     * be retrieved. 
+     *
+     * @param version        The version ID to look under.
+     * @param path           The simple absolute path to the parent directory.
+     * @param includeDeleted Whether to allow a deleted node to be retrieved
+     * @return               An AVMNodeDescriptor, or null if the version does not exist.
+     */
+    public AVMNodeDescriptor lookup(String ticket, int version, String path, boolean includeDeleted);
+
+    
     /**
      * Get a descriptor for the specified node.
      * @param dir The descriptor for the directory node.
@@ -265,6 +278,21 @@ public interface AVMRemoteTransport
      */
     public AVMNodeDescriptor lookup(String ticket, AVMNodeDescriptor dir, String name);
 
+    /**
+     * Lookup a node identified by the directory that contains it, and its name;
+     * optionally, the lookup can retrive the descriptor of a node even if 
+     * it has been deleted from its containing directory.
+     *
+     * @param dir            The descriptor for the directory node.
+     * @param name           The name to lookup.
+     * @param includeDeleted Whether to allow a deleted node to be retrieved via the lookup
+     * @return               The descriptor for the child, null if the child doesn't exist.
+     * @throws               AVMNotFoundException
+     * @throws               AVMWrongTypeException
+     */
+    public AVMNodeDescriptor lookup(String ticket, AVMNodeDescriptor dir, String name, boolean includeDeleted);
+
+    
     /**
      * Get the indirection path for a node.
      * @param version The version to look under.