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

Class XmlLicenseResource

java.lang.Object

org.ctan.site.resources.catalogue.api.XmlLicenseResource

@Path("/")
@Produces("application/xml")
public class XmlLicenseResource
extends Object

The class XmlLicenseResource contains the controller for the author resource.

Constructor Summary

Constructors

Constructor	Description
XmlLicenseResource(@NonNull LicenseStore store)	This is the constructor for the class XmlLicenseResource.

Method Summary

Modifier and Type	Method	Description
String	getLicenses(@NonNull String vers, String key, Boolean noDtd, Boolean noXml)	The method getLicenses provides means to retrieve a list of licenses 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

XmlLicenseResource

public XmlLicenseResource(@NonNull
 @NonNull LicenseStore store)

This is the constructor for the class XmlLicenseResource.

Parameters:

store - the underlying store

Method Details

getLicenses

@GET
@Path("/xml/{vers}/licenses")
@PermitAll
@UnitOfWork("siteDb")
public String getLicenses(@NonNull @PathParam("vers")
 @NonNull String vers,
 @QueryParam("key")
 String key,
 @QueryParam("no-dtd") @DefaultValue("false")
 Boolean noDtd,
 @QueryParam("no-xml") @DefaultValue("false")
 Boolean noXml)

The method getLicenses provides means to retrieve a list of licenses starting with a given pattern.

Parameters:

vers - the version number

key - the key

Returns:

a list of matching license summaries