inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-07-24 17:32:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Reorg so web-client can access LinkValidationService API from repo action framework.

Browse Source 
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@5857 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Jon Cox
2007-06-05 18:54:28 +00:00
parent cbeecf5fe5
commit 494859be2d
4 changed files with 428 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
source/java/org/alfresco/linkvalidation/HrefConcordanceEntry.java Normal file
View File

@@ -0,0 +1,65 @@
/*-----------------------------------------------------------------------------
* Copyright 2007 Alfresco Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. As a special
* exception to the terms and conditions of version 2.0 of the GPL, you may
* redistribute this Program in connection with Free/Libre and Open Source
* Software ("FLOSS") applications as described in Alfresco's FLOSS exception.
* You should have received a copy of the text describing the FLOSS exception,
* and it is also available here: http://www.alfresco.com/legal/licensing
*
*
* Author Jon Cox <jcox@alfresco.com>
* File HrefConcordanceEntry.java
*----------------------------------------------------------------------------*/
package org.alfresco.linkvalidation;
import java.io.Serializable;
/**
* Contains every location of a given href within a webapp,
* along with its response status.
*/
public class HrefConcordanceEntry
implements Comparable<HrefConcordanceEntry>,
Serializable
{
static final long serialVersionUID = -8102602003366089726L;
String href_;
String [] locations_;
int response_status_;
public HrefConcordanceEntry( String href,
String [] locations,
int responseStatus
)
{
href_ = href;
locations_ = locations;
response_status_ = responseStatus;
}
public String getHref() { return href_; }
public String [] getLocations() { return locations_; }
public int getResponseStatus() { return response_status_; }
public int compareTo(HrefConcordanceEntry other)
{
return href_.compareTo( other.href_ );
}
}

55
source/java/org/alfresco/linkvalidation/HrefManifest.java Normal file
View File

@@ -0,0 +1,55 @@
/*-----------------------------------------------------------------------------
* Copyright 2007 Alfresco Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. As a special
* exception to the terms and conditions of version 2.0 of the GPL, you may
* redistribute this Program in connection with Free/Libre and Open Source
* Software ("FLOSS") applications as described in Alfresco's FLOSS exception.
* You should have received a copy of the text describing the FLOSS exception,
* and it is also available here: http://www.alfresco.com/legal/licensing
*
*
* Author Jon Cox <jcox@alfresco.com>
* File HrefManifest.java
*----------------------------------------------------------------------------*/
package org.alfresco.linkvalidation;
import java.io.Serializable;
import java.util.List;
/**
* Contains a (possibly filtered) list of the hrefs within a file.
* Common uses of this class are to fetch the links in a web page
* or just the broken ones (i.e.: response status 400-599).
*/
public class HrefManifest implements Serializable
{
static final long serialVersionUID = 6532525229716576911L;
protected String file_;
protected List<String> hrefs_;
public HrefManifest( String file,
List<String> hrefs
)
{
file_ = file;
hrefs_ = hrefs;
}
public String getFileName() { return file_; }
public List<String> getHrefs() { return hrefs_;}
}

185
source/java/org/alfresco/linkvalidation/LinkValidationService.java Normal file
View File

@@ -0,0 +1,185 @@
/*-----------------------------------------------------------------------------
* Copyright 2007 Alfresco Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. As a special
* exception to the terms and conditions of version 2.0 of the GPL, you may
* redistribute this Program in connection with Free/Libre and Open Source
* Software ("FLOSS") applications as described in Alfresco's FLOSS exception.
* You should have received a copy of the text describing the FLOSS exception,
* and it is also available here: http://www.alfresco.com/legal/licensing
*
*
* Author Jon Cox <jcox@alfresco.com>
* File LinkValidationService.java
*----------------------------------------------------------------------------*/
package org.alfresco.linkvalidation;
import java.util.List;
import org.alfresco.service.cmr.avm.AVMNotFoundException;
public interface LinkValidationService
{
/**
* Updates href status and href file dependencies for path.
*
*
* @param storeNameOrWebappPath
* The store name or path to webapp
*
* @param incremental
* If true, updates information incrementally, based on the
* files that have changed and prior calculations regarding
* url-to-file dependencies. If false, first deletes all URL
* info associated with the store/webapp (if any), then does
* a full rescan to update info.
*
* @param connectTimeout
* Amount of time in milliseconds that this function will wait
* before declaring that the connection has failed
* (e.g.: 10000 ms).
*
* @param readTimeout
* time in milliseconds that this function will wait before
* declaring that a read on the connection has failed
* (e.g.: 30000 ms).
*
* @param nthreads
* Number of threads to use when fetching URLs (e.g.: 5)
*
* @param status
* While updateHrefInfo() is a synchronous function,
* 'status' may be polled in a separate thread to
* observe its progress.
*/
public void updateHrefInfo( String storeNameOrWebappPath,
boolean incremental,
int connectTimeout,
int readTimeout,
int nthreads,
UpdateHrefInfoStatus status
)
throws AVMNotFoundException;
/**
* Fetches information on broken hrefs within a store name or path
* to a webapp. This function is just a convenience wrapper for calling
* getHrefConcordance with statusGTE=400 and statusLTE=599.
*/
public List<HrefConcordanceEntry> getBrokenHrefConcordance(
String storeNameOrWebappPath
) throws AVMNotFoundException;
/**
* Returns information regarding the hrefs within storeNameOrWebappPath
* whose return status is greater than or equal to 'statusGTE', and
* less than or equal to 'statusLTE'. The List<HrefConcordanceEntry>
* is sorted in increasing lexicographic order by href. Within each
* HrefConcordanceEntry, the files retrieved via getLocations()
* are also sorted in increasing lexicographic order.
*
* <p>
* Example 1:<br>
* The following parameters will fetch all the broken links
* within the ROOT webapp in the staging area of the 'mysite' web project:
* <ul>
* <li> storeNameOrWebappPath="mysite:/www/avm_webapps/ROOT"
* <li> statusGTE=400
* <li> statusLTE=599
* <ul>
* <p>
* Example 2:<br>
* The following parameters will fetch all the links whose return status
* is "successful" (2xx) for all webapps contained by the staging area of
* the 'mysite' web project:
* <ul>
* <li> storeNameOrWebappPath="mysite"
* <li> statusGTE=200
* <li> statusLTE=299
* <ul>
* Example 3:<br>
* The following parameters will fetch all the links whose return status
* is 200 (OK) within the ROOT webapp in the staging area of the 'mysite'
* web project
* <ul>
* <li> storeNameOrWebappPath="mysite:/www/avm_webapps/ROOT"
* <li> statusGTE=200
* <li> statusLTE=200
* <ul>
* <p>
* For details regarding HTTP status codes, see:
* http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
*
*/
public List<HrefConcordanceEntry> getHrefConcordance(
String storeNameOrWebappPath,
int statusGTE,
int statusLTE
) throws AVMNotFoundException;
/**
* This function is just a convenience wrapper for calling
* getHrefManifests with statusGTE=400 and statusLTE=599.
*/
public List<HrefManifest> getBrokenHrefManifests(
String storeNameOrWebappPath
) throws AVMNotFoundException;
/**
* Returns a manifest consisting of just the broken hrefs
* within each file containing one or more broken href.
* The HrefManifest list is sorted in increasing lexicographic
* order by file name. The hrefs within each HrefManifest
* are also sorted in increasing lexicographic order.
*/
public List<HrefManifest> getHrefManifests(
String storeNameOrWebappPath,
int statusGTE,
int statusLTE) throws
AVMNotFoundException;
/**
* This function is just a convenience wrapper for calling
* getHrefManifest with statusGTE=400 and statusLTE=599.
* <p>
* Note: If you want to get the broken links in every file in
* a webapp or store, it's much more efficient to use
* getBrokenHrefManifests instead of this function.
*/
public HrefManifest getBrokenHrefManifest( String path)
throws AVMNotFoundException;
/**
* Returns a manifest of all the hrefs within the file specified by 'path'
* whose response status is greater than or equal to statusGTE,
* and less than or equal to statusLTE.
* <p>
* Note: If you want to get a list of manifests of every file in a
* webapp or store, it's much more efficient to use getHrefManifests
* instead of this function.
*/
public HrefManifest getHrefManifest( String path,
int statusGTE,
int statusLTE) throws
AVMNotFoundException;
public List<String> getHrefsDependentUponFile(String path);
}

123
source/java/org/alfresco/linkvalidation/UpdateHrefInfoStatus.java Normal file
View File

@@ -0,0 +1,123 @@
/*-----------------------------------------------------------------------------
* Copyright 2007 Alfresco Inc.
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. As a special
* exception to the terms and conditions of version 2.0 of the GPL, you may
* redistribute this Program in connection with Free/Libre and Open Source
* Software ("FLOSS") applications as described in Alfresco's FLOSS exception.
* You should have received a copy of the text describing the FLOSS exception,
* and it is also available here: http://www.alfresco.com/legal/licensing
*
*
* Author Jon Cox <jcox@alfresco.com>
* File UpdateHrefInfoStatus.java
*----------------------------------------------------------------------------*/
package org.alfresco.linkvalidation;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.atomic.AtomicBoolean;
/**
* This class allows the progress of synchronous calls to
* updateHrefInfo to be be monitored asynchronously
* in another thread via polling.
*
* Whenever the status monitoring thread wishes to determine
* how many of the webaps, directories, files, or URLs have
* been updated sucessfully so far, it can query
* getWebappUpdateCount(), getDirUpdateCount(),
* getFileUpdateCount(), or getUrlUpdateCount().
* The monitoring thread can determine when the
* call to updateHrefInfo() has completed by examining
* the value returned by isDone().
* <p>
* Note: It is safest to instantiate a fresh UpdateHrefInfoStatus
* object for every invocation of updateHrefInfo().
*/
public class UpdateHrefInfoStatus
{
AtomicInteger webapp_update_count_;
AtomicInteger dir_update_count_;
AtomicInteger file_update_count_;
AtomicInteger url_update_count_;
AtomicBoolean is_done_;
public UpdateHrefInfoStatus()
{
webapp_update_count_ = new AtomicInteger();
dir_update_count_ = new AtomicInteger();
file_update_count_ = new AtomicInteger();
url_update_count_ = new AtomicInteger();
is_done_ = new AtomicBoolean( false );
}
/**
* Returns the number of webapps that have been completely
* URL-revalidated thus far by a call to updateHrefInfo().
* Note that it is possible to revalidate every webapp
* in a store via updateHrefInfo(), so this value can
* be greater than 1.
*/
public int getWebappUpdateCount() { return webapp_update_count_.intValue();}
/**
* Returns the number of directories that have been completely
* URL-revalidated thus far by a call to updateHrefInfo().
*/
public int getDirUpdateCount() { return dir_update_count_.intValue(); }
/**
* Returns the number of files that have been completely
* URL-revalidated thus far by a call to updateHrefInfo().
*/
public int getFileUpdateCount() { return file_update_count_.intValue();}
/**
* Returns the number of distinct URLs that have been
* URL-revalidated thus far by a call to updateHrefInfo().
*/
public int getUrlUpdateCount() { return url_update_count_.intValue(); }
/**
* Returns true if and only if the call to updateHrefInfo() has returned
* (whether by a normal return or via an exception).
*/
public boolean isDone() { return is_done_.get(); }
void init()
{
setDone( false );
// some defensive measures against datastructure recycling
//
webapp_update_count_.set(0);
dir_update_count_.set(0);
file_update_count_.set(0);
url_update_count_.set(0);
}
int incrementWebappUpdateCount()
{
return webapp_update_count_.incrementAndGet();
}
int incrementDirUpdateCount() {return dir_update_count_.incrementAndGet(); }
int incrementFileUpdateCount(){return file_update_count_.incrementAndGet();}
int incrementUrlUpdateCount() {return url_update_count_.incrementAndGet(); }
void setDone(Boolean tf) { is_done_.set( tf ); }
}