Package org.ctan.site.resources.texarchive

Class Texarchive3Resource

java.lang.Object

org.ctan.site.resources.texarchive.Texarchive3Resource

@Path("/3.0")
@Produces({"application/json","application/xml"})
public class Texarchive3Resource
extends Object

The class TexArchive3Resource contains the controller for the /api/«xxx»/tex-archive resource.

Constructor Summary

Constructors

Constructor	Description
Texarchive3Resource(@NonNull TexArchiveService service)	This is the constructor for the class TexArchive3Resource.

Method Summary

Modifier and Type	Method	Description
TexArchiveService.TexarchiveListTo	getList(String path, int page, int size, String lang)	The method getList provides means to retrieve the listing for one directory.
Map<String,String>	getVersion()	The method getVersion provides means to retrieve the version number of the API.

Methods inherited from class java.lang.Object

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

Constructor Details

Texarchive3Resource

public Texarchive3Resource(@NonNull
 @NonNull TexArchiveService service)

This is the constructor for the class TexArchive3Resource.

Parameters:

service - the underlying service

Method Details

getList

@GET
@Path("/tex-archive/list/{path:.*}")
@PermitAll
@UnitOfWork("siteDb")
public TexArchiveService.TexarchiveListTo getList(@PathParam("path")
 String path,
 @QueryParam("page")
 int page,
 @QueryParam("size")
 int size,
 @QueryParam("lang")
 String lang)

The method getList provides means to retrieve the listing for one directory.

Parameters:

path - the path in the Te X archive

page - the page segment

size - the size of pages

lang - the language

Returns:

a list of files

getVersion

@GET
@Path("/admin/tex-archive/version")
@PermitAll
public Map<String,String> getVersion()

The method getVersion provides means to retrieve the version number of the API.

Returns:

a Map with a single attribute version containing the version number as String.