Package org.ctan.site.resources.admin

Class Blacklist3Resource

java.lang.Object

org.ctan.site.resources.admin.Blacklist3Resource

@Path("/3.0/admin")
@Produces("application/json")
public class Blacklist3Resource
extends Object

The class Blacklist3Resource contains the CRUD controller for the guest book black list resource.

Constructor Summary

Constructors

Constructor	Description
Blacklist3Resource(@NonNull BlacklistStore store)	This is the constructor for the class Blacklist3Resource.

Method Summary

Modifier and Type	Method	Description
Blacklist	create(@NonNull Blacklist stopword)	The method create provides an end-point to create a stop word.
Blacklist	get(@NonNull Long id)	The method retrieve provides means to retrieve a stop word.
GeneralPage	list(String q, int page, int size, String orderBy, boolean asc)	The method list provides means to retrieve a page of stop words.
boolean	remove(@NonNull Long id)	The method remove provides an end-point to remove a stop word.

Methods inherited from class java.lang.Object

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

Constructor Details

Blacklist3Resource

public Blacklist3Resource(@NonNull
 @NonNull BlacklistStore store)

This is the constructor for the class Blacklist3Resource.

Parameters:

store - the underlying store

Method Details

create

@POST
@Path("/blacklist")
@UnitOfWork("siteDb")
public Blacklist create(@NonNull
 @NonNull Blacklist stopword)

The method create provides an end-point to create a stop word.

Parameters:

stopword - the stop word object to store

Returns:

the updated stopword

get

@GET
@Path("/blacklist/{id}")
@UnitOfWork("siteDb")
public Blacklist get(@NonNull @PathParam("id")
 @NonNull Long id)

The method retrieve provides means to retrieve a stop word.

Parameters:

id - the id

Returns:

true iff the user exists

list

@GET
@Path("/blacklists")
@UnitOfWork("siteDb")
public GeneralPage list(@QueryParam("q")
 String q,
 @QueryParam("page")
 int page,
 @QueryParam("size")
 int size,
 @QueryParam("order")
 String orderBy,
 @QueryParam("asc")
 boolean asc)

The method list provides means to retrieve a page of stop words.

Parameters:

q - the name pattern

page - the page

size - the page size

orderBy - the order

asc - the indicator for ascending

Returns:

the page for the blacklist or null

remove

@DELETE
@Path("/blacklist/{id}")
@UnitOfWork("siteDb")
public boolean remove(@NonNull @PathParam("id")
 @NonNull Long id)

The method remove provides an end-point to remove a stop word.

Parameters:

id - the id

Returns:

true iff the user has existed