org.jooby.sitemap

Class Sitemap

java.lang.Object

org.jooby.internal.sitemap.JSitemap<Sitemap>

org.jooby.sitemap.Sitemap

All Implemented Interfaces:

Jooby.Module

public class Sitemap
extends org.jooby.internal.sitemap.JSitemap<Sitemap>

sitemap

Generate sitemap.xml files using jsitemapgenerator.

usage

 {
   use(new Sitemap());

   get("/page1", ..);
   get("/page2", ..);
 }
 

The module exports a /sitemap.xml route.

baseurl

The sitemap.xml specification requires an absolute url. The way we provide this absolute url is at creation time or using the sitemap.url property:

 {
   use(new Sitemap("https://foo.bar"));

   get("/page1", ..);
   get("/page2", ..);
 }
 

or

 sitemap.url = "http://foo.bar"
 

customize

The sitemap generator builds a sitemap.xml file with loc elements. You can customize the output in one of two ways:

declarative

 {

   get("/")
     .get("/page1", ..)
     .get("/page2", ..)
     .attr("changefreq", "weekly")
     .attr("priority", "1");
 }
 

We first group route under a common path: / and add some routers. Then for each router we set the changefrequency and priority.

programmatically

 {

   use(new Sitemap().with(r -> {
     WebPage page = new WebPage();
     page.setName(r.pattern());
     page.setChangeFreq(ChangeFreq.ALWAYS);
     page.setPriority(1);
     return Arrays.asList(page);
   }));

   get("/")
     .get("/page1", ..)
     .get("/page2", ..);
 }
 

Here we built WebPage objects and set frequency and priority.

dynamic page generation

Suppose you have a product route dynamically mapped as:

 {
   get("/products/:sku", ...);
 }
 

How do you generate urls for all your products?

Dynamic urls are supported via custom WebPageProvider:

 {
   use(new Sitemap().with(SKUPageProvider.class));

   get("/products/:sku", ...);
 }
 

SKUPageProvider.java:

 public class SKUPageProvider implements WebPageProvider {

   private MyDatabase db;

   @Inject
   public SKUPageProvider(MyDatabase db) {
     this.db = db;
   }

   public List<WebPage> apply(Route.Definition route) {
     if (route.pattern().startsWith("/products")) {
       // multiple urls
       return db.findSKUS().stream().map(sku -> {
           WebPage webpage = new WebPage();
           webpage.setName(route.reverse(sku));
           return webpage;
         }).collect(Collectors.toList());
     }
     // single url
     WebPage webpage = new WebPage();
     webpage.setName(route.pattern());
     return Arrays.asList(webpage);
   }
 }
 

filter

The filter(java.util.function.Predicate) option allows to excludes routes from final output:

 {
   use(new Sitemap().filter(route -> !route.pattern().startsWith("/api")));
 }
 

Since:

1.0.0.CR

Author:

edgar

Constructor Summary

Constructors

Constructor and Description
Sitemap() Creates a new Sitemap.
Sitemap(String baseurl) Creates a new Sitemap and set the base url.

Method Summary

Modifier and Type	Method and Description
Sitemap	filter(Predicate<Route.Definition> filter) filter
Sitemap	with(Class<? extends WebPageProvider> wpp) Set a custom WebPageProvider.
Sitemap	with(WebPageProvider wpp) Set a custom WebPageProvider.

Methods inherited from class org.jooby.internal.sitemap.JSitemap

configure

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jooby.Jooby.Module

config

Constructor Detail

Sitemap

public Sitemap()

Creates a new Sitemap.

Sitemap

public Sitemap(String baseurl)

Creates a new Sitemap and set the base url.

Parameters:

baseurl - Base url to use.

Method Detail

filter

public Sitemap filter(Predicate<Route.Definition> filter)

filter

The filter(java.util.function.Predicate) option allows to excludes routes from final output:

 {
   use(new Sitemap().filter(route -> !route.pattern().startsWith("/api")));
 }
 

Overrides:

filter in class org.jooby.internal.sitemap.JSitemap<Sitemap>

with

public Sitemap with(WebPageProvider wpp)

Set a custom WebPageProvider.

 {

   use(new Sitemap().with(r -> {
     WebPage page = new WebPage();
     page.setName(r.pattern());
     page.setChangeFreq(ChangeFreq.ALWAYS);
     page.setPriority(1);
     return Arrays.asList(page);
   }));
 }
 

Overrides:

with in class org.jooby.internal.sitemap.JSitemap<Sitemap>

Parameters:

wpp - A web page provider.

with

public Sitemap with(Class<? extends WebPageProvider> wpp)

Set a custom WebPageProvider.

 {
   use(new Sitemap().with(MyWebPageProvider.class));
 }
 

The MyWebPageProvider will be created and injected by Guice.

Overrides:

with in class org.jooby.internal.sitemap.JSitemap<Sitemap>

Parameters:

wpp - A web page provider.