Package org.ctan.site.resources.catalogue.api

Class JsonPkgResource

java.lang.Object

org.ctan.site.resources.catalogue.api.JsonPkgResource

@Path("/")
@Produces("application/json")
public class JsonPkgResource
extends Object

The class AuthorResource.java contains the controller for the author resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	JsonPkgResource.AuthorShortTo	The class AuthorShortTo contains the transport object for authors references.
protected static class	JsonPkgResource.AuthorTo	The class AuthorTo contains the transport object for authors.
protected static class	JsonPkgResource.CopyrightTo	The class CopyrightTo contains the transport object for copyright information.
protected static class	JsonPkgResource.CtanTo	The class CtanTo contains the transport object for references to the tex-archive.
protected static class	JsonPkgResource.DescriptionTo	The class DescriptionTo contains the transport object for a package description.
protected static class	JsonPkgResource.DocTo	The class DocTo contains the transport object for package documentation.
protected static class	JsonPkgResource.ListItemTo	The class ListItemTo contains the transport object for list items.
protected static class	JsonPkgResource.PackageTo	The class PackageTo contains the transport object for a package.
protected static class	JsonPkgResource.VersionTo	The class VersionTo contains the transport object for the version number.

Constructor Summary

Constructors

Constructor	Description
JsonPkgResource(@NonNull PkgStore store)	This is the constructor for the class PkgResource.

Method Summary

Modifier and Type	Method	Description
List<JsonPkgResource.ListItemTo>	getPackages(@NonNull String vers, String key)	The method getPackages provides means to retrieve a list of packages starting with a given pattern.
JsonPkgResource.PackageTo	getPkgByKey(@NonNull String vers, @NonNull String id, Boolean authorNames, String drop)	The method getPkgByKey provides means to retrieve a package.

Methods inherited from class java.lang.Object

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

Constructor Details

JsonPkgResource

public JsonPkgResource(@NonNull
 @NonNull PkgStore store)

This is the constructor for the class PkgResource.

Parameters:

store - the underlying store

Method Details

getPackages

@GET
@Path("/json/{vers}/packages")
@PermitAll
@UnitOfWork("siteDb")
public List<JsonPkgResource.ListItemTo> getPackages(@NonNull @PathParam("vers")
 @NonNull String vers,
 @QueryParam("key")
 String key)

The method getPackages provides means to retrieve a list of packages starting with a given pattern.

Parameters:

vers - the version number

key - the pattern for the key

Returns:

a list of matching package summaries

getPkgByKey

@GET
@Path("/json/{vers}/pkg/{id}")
@PermitAll
@UnitOfWork("siteDb")
public JsonPkgResource.PackageTo getPkgByKey(@NonNull @PathParam("vers")
 @NonNull String vers,
 @NonNull @PathParam("id")
 @NonNull String id,
 @QueryParam("author-names")
 Boolean authorNames,
 @QueryParam("drop")
 String drop)

The method getPkgByKey provides means to retrieve a package.

Parameters:

vers - the version

id - the key of the package

authorNames - ...

drop - ...

Returns:

an package or null