Package org.dspace.app.sitemap

Class GenerateSitemaps

java.lang.Object

org.dspace.app.sitemap.GenerateSitemaps

public class GenerateSitemaps
extends Object

Command-line utility for generating HTML and Sitemaps.org protocol Sitemaps.

Author:

Robert Tansley, Stuart Lewis

Method Summary

Modifier and Type	Method	Description
static void	deleteSitemaps()	Delete the sitemaps directory and its contents if it exists
static void	generateSitemaps(boolean makeHTMLMap, boolean makeSitemapOrg)	Generate sitemap.org protocol and/or basic HTML sitemaps.
static void	generateSitemapsScheduled()	Runs generate-sitemaps without any params for the scheduler (task-scheduler.xml).
static void	main(String[] args)
static void	pingConfiguredSearchEngines()	Ping all search engines configured in dspace.cfg.
static void	pingSearchEngine(String engineURL)	Ping the given search engine.

Methods inherited from class java.lang.Object

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

Method Detail

main

public static void main(String[] args)
                 throws Exception

Throws:

Exception

generateSitemapsScheduled

public static void generateSitemapsScheduled()
                                      throws IOException,
                                             SQLException

Runs generate-sitemaps without any params for the scheduler (task-scheduler.xml).

Throws:

SQLException - if a database error occurs.

IOException - if IO error occurs.

deleteSitemaps

public static void deleteSitemaps()
                           throws IOException

Delete the sitemaps directory and its contents if it exists

Throws:

IOException - if IO error occurs

generateSitemaps

public static void generateSitemaps(boolean makeHTMLMap,
                                    boolean makeSitemapOrg)
                             throws SQLException,
                                    IOException

Generate sitemap.org protocol and/or basic HTML sitemaps.

Parameters:

makeHTMLMap - if true, generate an HTML sitemap.

makeSitemapOrg - if true, generate an sitemap.org sitemap.

Throws:

SQLException - if database error if a database error occurs.

IOException - if IO error if IO error occurs.

pingConfiguredSearchEngines

public static void pingConfiguredSearchEngines()
                                        throws UnsupportedEncodingException

Ping all search engines configured in dspace.cfg.

Throws:

UnsupportedEncodingException - theoretically should never happen

pingSearchEngine

public static void pingSearchEngine(String engineURL)
                             throws MalformedURLException,
                                    UnsupportedEncodingException

Ping the given search engine.

Parameters:

engineURL - Search engine URL minus protocol etc, e.g. www.google.com

Throws:

MalformedURLException - if the passed in URL is malformed

UnsupportedEncodingException - theoretically should never happen