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

Class JsonAuthorResource

java.lang.Object

org.ctan.site.resources.catalogue.api.JsonAuthorResource

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

The class JsonAuthorResource contains the controller for the author resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	JsonAuthorResource.AuthorSummaryTo	The class AuthorSummaryTo contains the transport object for the author resource in the summary list.
protected static class	JsonAuthorResource.AuthorTo	The class AuthorTo contains the transport object for the author resource.
protected static class	JsonAuthorResource.PkgSummaryTo	The class PkgSummaryTo contains the transport object for the package of the author resource.

Constructor Summary

Constructors

Constructor	Description
JsonAuthorResource(@NonNull AuthorStore store)	This is the constructor for the class JsonAuthorResource.

Method Summary

Modifier and Type	Method	Description
JsonAuthorResource.AuthorTo	getAuthorByKey(@NonNull String vers, @NonNull String id, Boolean ref)	The method getAuthorByKey provides means to retrieve an author.
List<JsonAuthorResource.AuthorSummaryTo>	getAuthors(@NonNull String vers, String key)	The method getAuthors provides means to retrieve a list of authors starting with a given pattern.

Methods inherited from class java.lang.Object

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

Constructor Details

JsonAuthorResource

public JsonAuthorResource(@NonNull
 @NonNull AuthorStore store)

This is the constructor for the class JsonAuthorResource.

Parameters:

store - the underlying store

Method Details

getAuthorByKey

@GET
@Path("/json/{vers}/author/{id}")
@PermitAll
@UnitOfWork("siteDb")
public JsonAuthorResource.AuthorTo getAuthorByKey(@NonNull @PathParam("vers")
 @NonNull String vers,
 @NonNull @PathParam("id")
 @NonNull String id,
 @QueryParam("ref") @DefaultValue("false")
 Boolean ref)

The method getAuthorByKey provides means to retrieve an author.

Parameters:

vers - the version

id - the key of the author

ref - the indicator whether or not to return the references to the packages authored by the author

Returns:

an author or null

getAuthors

@GET
@Path("/json/{vers}/authors")
@PermitAll
@UnitOfWork("siteDb")
public List<JsonAuthorResource.AuthorSummaryTo> getAuthors(@NonNull @PathParam("vers")
 @NonNull String vers,
 @QueryParam("key")
 String key)

The method getAuthors provides means to retrieve a list of authors starting with a given pattern.

Parameters:

vers - the version number

key - the key

Returns:

a list of matching author summaries