Package org.ctan.site.resources.catalogue

Class Topic3Resource

java.lang.Object

org.ctan.site.resources.catalogue.Topic3Resource

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

The class Topic3Resource contains the controller for the topic resource.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	Topic3Resource.TopicInfoTo	The class TopicInfoTo contains the transport object for topic infos.
protected static class	Topic3Resource.TopicPkgTo	The class TopicPkgTo contains the transport object for packages.
protected static class	Topic3Resource.TopicSummaryTo	The class TopicSummaryTo contains the transport object for the topic resource in the summary list.
protected static class	Topic3Resource.TopicTo	The class TopicTo contains the transport object for the topic resource.

Constructor Summary

Constructors

Constructor	Description
Topic3Resource(@NonNull CtanConfiguration.CtanConfig config, @NonNull TopicStore store, @NonNull ContentService contentService, @NonNull VoteStore voteStore)	This is the constructor for the class Topic3Resource.

Method Summary

Modifier and Type	Method	Description
List<Topic3Resource.TopicInfoTo>	getRandomTopics(int count, String lang)	The method getRandomTopics provides means to retrieve a random list of topics.
Topic3Resource.TopicTo	getTopicByKey(@NonNull String id, String lang)	The method getTopic provides means to retrieve a topic by its id.
List<Topic3Resource.TopicSummaryTo>	getTopics(String pattern, String lang, long page, long size)	The method getTopics provides means to retrieve a list of authors starting with a given pattern.
List<Topic3Resource.TopicSummaryTo>	getTopics0(String lang)	The method getTopics0 provides means to retrieve a list of topics starting with a given pattern.
List<Topic3Resource.TopicSummaryTo>	getTopicsList(String lang)	The method getTopicsList provides means to retrieve a list of topics 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

Topic3Resource

public Topic3Resource(@NonNull
 @NonNull CtanConfiguration.CtanConfig config,
 @NonNull
 @NonNull TopicStore store,
 @NonNull
 @NonNull ContentService contentService,
 @NonNull
 @NonNull VoteStore voteStore)

This is the constructor for the class Topic3Resource.

Parameters:

config - the configuration

store - the underlying store

contentService - the content service

Method Details

getRandomTopics

@GET
@Path("/rnd/topics")
@PermitAll
@UnitOfWork("siteDb")
public List<Topic3Resource.TopicInfoTo> getRandomTopics(@QueryParam("size") @DefaultValue("3")
 int count,
 @QueryParam("lang") @DefaultValue("en")
 String lang)

The method getRandomTopics provides means to retrieve a random list of topics.

Returns:

the configuration

getTopicByKey

@GET
@Path("/topic/{id}")
@PermitAll
@UnitOfWork("siteDb")
public Topic3Resource.TopicTo getTopicByKey(@NonNull @PathParam("id")
 @NonNull String id,
 @QueryParam("lang")
 String lang)

The method getTopic provides means to retrieve a topic by its id.

Parameters:

id - the id

lang - the language

Returns:

the topic or null

getTopics

@GET
@Path("/topics/{pattern}")
@PermitAll
@UnitOfWork("siteDb")
public List<Topic3Resource.TopicSummaryTo> getTopics(@PathParam("pattern")
 String pattern,
 @QueryParam("lang")
 String lang,
 @DefaultValue("0") @QueryParam("page")
 long page,
 @DefaultValue("16") @QueryParam("size")
 long size)

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

Parameters:

pattern - the initial string of the name

lang - the language code

page - the page

size - the page size

Returns:

a list of matching author summaries

getTopics0

@GET
@Path("/topics")
@PermitAll
@UnitOfWork("siteDb")
public List<Topic3Resource.TopicSummaryTo> getTopics0(@QueryParam("lang")
 String lang)

The method getTopics0 provides means to retrieve a list of topics starting with a given pattern.

Parameters:

lang - the language code

Returns:

a list of matching topics

getTopicsList

@GET
@Path("/topic/list")
@PermitAll
@UnitOfWork("siteDb")
public List<Topic3Resource.TopicSummaryTo> getTopicsList(@QueryParam("lang")
 String lang)

The method getTopicsList provides means to retrieve a list of topics starting with a given pattern.

Parameters:

lang - the language code

Returns:

a list of matching topics