Package org.ctan.site.resources

Class Sitemap3Resource

java.lang.Object

org.ctan.site.resources.Sitemap3Resource

@Path("/3.0")
public class Sitemap3Resource
extends Object

The class Sitemap3Resource contains the controller for the version resource.

Constructor Summary

Constructors

Constructor	Description
Sitemap3Resource(@NonNull SitemapService service)	This is the constructor for Sitemap3Resource.

Method Summary

Modifier and Type	Method	Description
SitemapService.SitemapList	sitemap()	The method sitemap provides means to retrieve the site map as JSON.
String	sitemapVersion()	The method sitemapVersion provides means to retrieve the current version number.
String	sitemapXml()	The method sitemapXml provides means to the site map as XML.

Methods inherited from class java.lang.Object

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

Constructor Details

Sitemap3Resource

public Sitemap3Resource(@NonNull
 @NonNull SitemapService service)

This is the constructor for Sitemap3Resource.

Parameters:

service - the underlying service

Method Details

sitemap

@GET
@Path("sitemap")
@Produces("application/json")
@PermitAll
public SitemapService.SitemapList sitemap()

The method sitemap provides means to retrieve the site map as JSON.

Returns:

the sitemap items

sitemapVersion

@GET
@Path("sitemap/version")
@Produces("application/json")
@PermitAll
public String sitemapVersion()

The method sitemapVersion provides means to retrieve the current version number.

Returns:

the version number as string

sitemapXml

@GET
@Path("sitemap/xml")
@Produces("application/xml")
@PermitAll
public String sitemapXml()

The method sitemapXml provides means to the site map as XML.

Returns:

the urlset