Package org.ctan.site.resources.catalogue

Class Bibtex3Resource

java.lang.Object

org.ctan.site.resources.catalogue.Bibtex3Resource

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

The class Bibtex3Resource contains the controller for the bibtex resource.

Constructor Summary

Constructors

Constructor	Description
Bibtex3Resource(@NonNull BibtexService service)	This is the constructor for the class Bibtex3Resource.

Method Summary

Modifier and Type	Method	Description
String	getBibtex(@NonNull String key, String keyPrefix, boolean omitAbstract, boolean useString, String type)	The method getBibtex contains the end-point for /bibtex/key.
String	getBibtexAll(String keyPrefix, boolean omitAbstract, boolean useString, String type)	The method getBibtexAll contains the end-point for /bibtex.

Methods inherited from class java.lang.Object

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

Constructor Details

Bibtex3Resource

public Bibtex3Resource(@NonNull
 @NonNull BibtexService service)

This is the constructor for the class Bibtex3Resource.

Parameters:

service - the underlying service

Method Details

getBibtex

@GET
@Path("/bibtex/{key}")
@PermitAll
@UnitOfWork("siteDb")
@Produces("text/plain")
public String getBibtex(@NonNull @PathParam("key")
 @NonNull String key,
 @QueryParam("key-prefix")
 String keyPrefix,
 @QueryParam("omit-abstract")
 boolean omitAbstract,
 @QueryParam("use-string")
 boolean useString,
 @QueryParam("type")
 String type)

The method getBibtex contains the end-point for /bibtex/key. It returns the BibTeX file.

Parameters:

key - the key

keyPrefix - the key prefix

omitAbstract - indicator to omit the abstract

useString - indicator to use the @String definition

type - the type of the entry

Returns:

the BibTeX file

getBibtexAll

@GET
@Path("/bibtex")
@PermitAll
@UnitOfWork("siteDb")
@Produces("text/plain;charset=UTF-8")
public String getBibtexAll(@QueryParam("key-prefix")
 String keyPrefix,
 @QueryParam("omit-abstract")
 boolean omitAbstract,
 @QueryParam("use-string")
 boolean useString,
 @QueryParam("type")
 String type)

The method getBibtexAll contains the end-point for /bibtex. It returns the BibTeX file.

Attention: This service is too slow to be exposable!

Parameters:

keyPrefix - the key prefix

omitAbstract - indicator to omit the abstract

useString - indicator to use the @String definition

type - the type of the entry

Returns:

the BibTeX file