io.earcam.utilitarian.site.sitemap

Class Sitemaps

java.lang.Object

io.earcam.utilitarian.site.sitemap.Sitemaps

public final class Sitemaps
extends Object

Static entry point for Sitemaps

Method Summary

Modifier and Type	Method and Description
static Path	create(SitemapParameters parameters) Based on the parameters, generates an arbitrary number of sitemap.xml files
static Path	index(Path targetDir, Stream<Path> targetDirs) Creates sitemap-index.xml file(s) for all sitemap.xml files listed in any cache file ( ) in the targetDirs
static Path	index(SitemapParameters parameters, Stream<Path> targetDirs)
static void	robotsTxt(Path targetDir) Generates a robots.txt file in the targetDir, based on the sitemap indices cache list there.
static String	submit(Path targetDir, URI baseUrl, List<String> hosts) Submits sitemap indices to a given list of search engines

Methods inherited from class java.lang.Object

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

Method Detail

create

public static Path create(SitemapParameters parameters)

Based on the parameters, generates an arbitrary number of sitemap.xml files

Parameters:

parameters -

Returns:

path to a text file cache containing the filenames of generated sitemaps

Throws:

IOException - if unable to write the files or cache

index

public static Path index(Path targetDir,
                         Stream<Path> targetDirs)

Creates sitemap-index.xml file(s) for all sitemap.xml files listed in any cache file ( ) in the targetDirs

Parameters:

targetDir - where to write the index/indices

targetDirs - where to look for sitemap listing cache files

Returns:

a path to a cache file () listing the created index/indices

Throws:

IOException - if unable to write the files or read the caches

index

public static Path index(SitemapParameters parameters,
                         Stream<Path> targetDirs)

submit

public static String submit(Path targetDir,
                            URI baseUrl,
                            List<String> hosts)

Submits sitemap indices to a given list of search engines

Parameters:

targetDir -

baseUrl -

hosts -

Returns:

robotsTxt

public static void robotsTxt(Path targetDir)

Generates a robots.txt file in the targetDir, based on the sitemap indices cache list there.

If no sitemap indices exist then a permissive robots.txt will still be generated.

Parameters:

targetDir - the directory to read the cache list from, and write the robots.txt file to

Throws:

UncheckedIOException - if unable to write the file or read the cache