Package io.goobi.viewer.api.rest.v1.clients

Class ClientApplicationsResource

java.lang.Object

io.goobi.viewer.api.rest.v1.clients.ClientApplicationsResource

@Path("/clients")
public class ClientApplicationsResource
extends Object

Author:

florian

Constructor Summary

Constructors

Constructor	Description
ClientApplicationsResource()
ClientApplicationsResource(IDAO dao, ClientApplicationManager clientManager)

Method Summary

Modifier and Type	Method	Description
List<ClientApplication>	getAllClients()	List all registered ClientApplications
ClientApplication	getClient(String clientIdentifier)	List all registered ClientApplications
String	register()
String	request()
ClientApplication	setClient(String clientIdentifier, ClientApplication update)	Change properties of an existing ClientApplication

Methods inherited from class java.lang.Object

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

Constructor Details

ClientApplicationsResource

public ClientApplicationsResource()
                           throws DAOException

Throws:

DAOException

ClientApplicationsResource

public ClientApplicationsResource(IDAO dao,
 ClientApplicationManager clientManager)

Method Details

register

@POST
@Path("/register")
@Produces("application/json")
public String register()
                throws de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException,
DAOException

Throws:

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

DAOException

request

@GET
@Path("/request")
@Produces("application/json")
public String request()
               throws de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException,
DAOException

Throws:

de.unigoettingen.sub.commons.contentlib.exceptions.ContentLibException

DAOException

setClient

@PUT
@Path("/{id}")
@Produces("application/json")
public ClientApplication setClient(@PathParam("id")
 String clientIdentifier,
 ClientApplication update)
                            throws DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

Change properties of an existing ClientApplication

Parameters:

clientIdentifier -

update -

Returns:

ClientApplication

Throws:

DAOException - If an error occurs accessing the database

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException - If no 'id' or 'clientIdentier' values are given or if no matching client could be found

getAllClients

@GET
@Produces("application/json")
public List<ClientApplication> getAllClients()
                                      throws DAOException

List all registered ClientApplications

Returns:

All clients from the DB

Throws:

DAOException - If an error occurs accessing the database

getClient

@GET
@Path("/{id}")
@Produces("application/json")
public ClientApplication getClient(@PathParam("id")
 String clientIdentifier)
                            throws DAOException,
de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException

List all registered ClientApplications

Parameters:

clientIdentifier -

Returns:

Client with given clientIdentifier

Throws:

DAOException - If an error occurs accessing the database

de.unigoettingen.sub.commons.contentlib.exceptions.ContentNotFoundException