org.alfresco.linkvalidation
Interface LinkValidationService


Deprecated. will be removed in future release

public interface LinkValidationService


Method Summary
 HrefManifest getBrokenHrefManifest(HrefDifference hdiff)
          Deprecated. This function is applied to difference objects created by comparing webapps in an author or workflow store to the staging area they overlay.
 HrefManifest getBrokenHrefManifest(java.lang.String webappPath)
          Deprecated. This function is applied to a webapp in staging, and is just a convenience wrapper for calling getHrefManifestEntries with statusGTE=400 and statusLTE=599.
 HrefDifference getHrefDifference(java.lang.String srcWebappPath, java.lang.String dstWebappPath, HrefValidationProgress progress)
          Deprecated. Fetch the difference between two areas.
 HrefManifest getHrefManifest(java.lang.String webappPath, int statusGTE, int statusLTE)
          Deprecated. This function is applied to webapps in staging and returns a manifest consisting of just the broken hrefs within each file containing one or more broken href.
 HrefManifest getHrefManifestBrokenByNewOrMod(HrefDifference hdiff)
          Deprecated. Fetches a manifest of all hyperlinks broken in new or modified files in an HrefDifference.
 java.util.List getHrefsDependentUponFile(java.lang.String path)
          Deprecated. Fetch all hyperlinks that rely upon the existence of the file specified by 'path', directly or indirectly.
 int getPollInterval()
          Deprecated. Returns the poll interval (in milliseconds) used to check for new snapshots in staging.
 boolean isLinkValidationDisabled()
          Deprecated.  
 void onBootstrap()
          Deprecated.  
 void onShutdown()
          Deprecated.  
 void updateHrefInfo(java.lang.String path, boolean incremental, boolean validateExternal, HrefValidationProgress progress)
          Deprecated. WARNING: this function won't be part of the public interface for long.
 

Method Detail

onBootstrap

void onBootstrap()
Deprecated. 

onShutdown

void onShutdown()
Deprecated. 

getPollInterval

int getPollInterval()
Deprecated. 
Returns the poll interval (in milliseconds) used to check for new snapshots in staging.


getBrokenHrefManifest

HrefManifest getBrokenHrefManifest(java.lang.String webappPath)
                                   throws AVMNotFoundException,
                                          java.net.SocketException,
                                          java.lang.IllegalArgumentException
Deprecated. 
This function is applied to a webapp in staging, and is just a convenience wrapper for calling getHrefManifestEntries with statusGTE=400 and statusLTE=599.

Note: Files and urls within this list of manifests pertain to the latest validated snapshot of staging (which may be somewhat older than the very latest snapshot). The validation service attempts to keep the latest validated snapshot as new as possible, automatically.

Throws:
AVMNotFoundException
java.net.SocketException
java.lang.IllegalArgumentException

getHrefManifest

HrefManifest getHrefManifest(java.lang.String webappPath,
                             int statusGTE,
                             int statusLTE)
                             throws AVMNotFoundException,
                                    java.net.SocketException,
                                    java.lang.IllegalArgumentException
Deprecated. 
This function is applied to webapps in staging and returns a manifest consisting of just the broken hrefs within each file containing one or more broken href. The HrefManifestEntry list is sorted in increasing lexicographic order by file name. The hrefs within each HrefManifestEntry are also sorted in increasing lexicographic order.

Throws:
AVMNotFoundException
java.net.SocketException
java.lang.IllegalArgumentException

getHrefDifference

HrefDifference getHrefDifference(java.lang.String srcWebappPath,
                                 java.lang.String dstWebappPath,
                                 HrefValidationProgress progress)
                                 throws AVMNotFoundException,
                                        java.net.SocketException,
                                        javax.net.ssl.SSLException,
                                        LinkValidationAbortedException
Deprecated. 
Fetch the difference between two areas. Version -1 is assumed for src; dst relies on the state of the link validation service updating link validity tables. Typically, this will be for some version close to the latest snapshot, but it's async, so it might be older.

Throws:
AVMNotFoundException
java.net.SocketException
javax.net.ssl.SSLException
LinkValidationAbortedException

getBrokenHrefManifest

HrefManifest getBrokenHrefManifest(HrefDifference hdiff)
                                   throws AVMNotFoundException,
                                          java.net.SocketException
Deprecated. 
This function is applied to difference objects created by comparing webapps in an author or workflow store to the staging area they overlay.

Throws:
AVMNotFoundException
java.net.SocketException

getHrefManifestBrokenByNewOrMod

HrefManifest getHrefManifestBrokenByNewOrMod(HrefDifference hdiff)
Deprecated. 
Fetches a manifest of all hyperlinks broken in new or modified files in an HrefDifference. The entries in this manifest are in the 'src' namespace of the HrefDifference operation (i.e.: files & urls from alice, not staging).

Parameters:
hdiff - The difference between two webapps obtained by calling getHrefDifference().

updateHrefInfo

void updateHrefInfo(java.lang.String path,
                    boolean incremental,
                    boolean validateExternal,
                    HrefValidationProgress progress)
                    throws AVMNotFoundException,
                           java.net.SocketException,
                           javax.net.ssl.SSLException,
                           LinkValidationAbortedException
Deprecated. 
WARNING: this function won't be part of the public interface for long. Updates href status and href file dependencies for path.

Parameters:
path -
  • If null, do all stores & all webapps in them.
  • If store, do all webapps in store
  • If webapp, do webapp.
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.
progress - While updateHrefInfo() is a synchronous function, 'status' may be polled in a separate thread to observe its progress.
Throws:
AVMNotFoundException
java.net.SocketException
javax.net.ssl.SSLException
LinkValidationAbortedException

getHrefsDependentUponFile

java.util.List getHrefsDependentUponFile(java.lang.String path)
Deprecated. 
Fetch all hyperlinks that rely upon the existence of the file specified by 'path', directly or indirectly. The list of hrefs returnd is sorted in increasing lexicographic order. For example, in alfresco-sample-website.war, the hrefs dependent upon mysite:/www/avm_webapps/ROOT/assets/footer.html are:
     http://mysite.www--sandbox.version--v-1.127-0-0-1.ip.alfrescodemo.net:8180/
     http://mysite.www--sandbox.version--v-1.127-0-0-1.ip.alfrescodemo.net:8180/assets/footer.html
     http://mysite.www--sandbox.version--v-1.127-0-0-1.ip.alfrescodemo.net:8180/index.jsp
     http://mysite.www--sandbox.version--v-1.127-0-0-1.ip.alfrescodemo.net:8180/media/releases/index.jsp
  
Note that this list may contain links that are functionally equivalent (e.g.: the first and third links), and may also contain links that don't actually appear an any web page, but are implicitly present in the site because any asset can be "dead reckoned".


isLinkValidationDisabled

boolean isLinkValidationDisabled()
Deprecated. 


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.