edu.msu.nscl.olog

Class LogbooksResource

java.lang.Object

edu.msu.nscl.olog.LogbooksResource

public class LogbooksResource
extends Object

Top level Jersey HTTP methods for the .../logbooks URL

Author:

Eric Berryman taken from Ralph Lange

Constructor Summary

Constructors

Constructor and Description
LogbooksResource() Creates a new instance of LogbooksResource

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	add(Logbooks data) POST method for creating multiple logbooks.
javax.ws.rs.core.Response	addSingle(String logbook, Long logId) PUT method for adding the logbook identified by logbook to the log id (both path parameters).
javax.ws.rs.core.Response	create(String logbookName, Logbook data) PUT method for creating and exclusively adding the logbook identified by the path parameter logbookName to all logs identified by the payload structure data.
javax.ws.rs.core.Response	list() GET method for retrieving the list of logbooks in the database.
javax.ws.rs.core.Response	read(String logbook) GET method for retrieving the logbook with the path parameter logbookName .
javax.ws.rs.core.Response	remove(String logbook) DELETE method for deleting the logbook identified by the path parameter name from all logs.
javax.ws.rs.core.Response	removeSingle(String logbook, Long logId) DELETE method for deleting the logbook identified by logbook from the log id (both path parameters).
javax.ws.rs.core.Response	update(String logbook, Logbook data) POST method for updating the logbook identified by the path parameter name, adding it to all logs identified by the payload structure data.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogbooksResource

public LogbooksResource()

Creates a new instance of LogbooksResource

Method Detail

list

public javax.ws.rs.core.Response list()

GET method for retrieving the list of logbooks in the database.

Returns:

list of logs with their logbooks and tags that match

add

public javax.ws.rs.core.Response add(Logbooks data)
                              throws IOException

POST method for creating multiple logbooks.

Parameters:

data - Logbooks data (from payload)

Returns:

HTTP Response

Throws:

IOException - when audit or log fail

read

public javax.ws.rs.core.Response read(String logbook)

GET method for retrieving the logbook with the path parameter logbookName .

Parameters:

logbook - URI path parameter: logbook name to search for

Returns:

list of logs with their logbooks and tags that match

create

public javax.ws.rs.core.Response create(String logbookName,
                               Logbook data)

PUT method for creating and exclusively adding the logbook identified by the path parameter logbookName to all logs identified by the payload structure data. Setting the owner attribute in the XML root element is mandatory. Values for the logbooks are taken from the payload.

Parameters:

logbook - URI path parameter: logbook name

data - list of logs to add the logbook name to

Returns:

HTTP Response

update

public javax.ws.rs.core.Response update(String logbook,
                               Logbook data)

POST method for updating the logbook identified by the path parameter name, adding it to all logs identified by the payload structure data. Setting the owner attribute in the XML root element is mandatory. Values for the logbooks are taken from the payload.

Parameters:

logbook - URI path parameter: logbook name

data - list of logs to add the logbook name to

Returns:

HTTP Response

remove

public javax.ws.rs.core.Response remove(String logbook)

DELETE method for deleting the logbook identified by the path parameter name from all logs.

Parameters:

logbook - URI path parameter: logbook name to remove

Returns:

HTTP Response

addSingle

public javax.ws.rs.core.Response addSingle(String logbook,
                                  Long logId)

PUT method for adding the logbook identified by logbook to the log id (both path parameters).

Parameters:

logbook - URI path parameter: logbook name

logId - URI path parameter: log to addSingle logbook to

data - tag data (specifying tag ownership)

Returns:

HTTP Response

removeSingle

public javax.ws.rs.core.Response removeSingle(String logbook,
                                     Long logId)

DELETE method for deleting the logbook identified by logbook from the log id (both path parameters).

Parameters:

logbook - URI path parameter: logbook name to remove

logId - URI path parameter: log to remove logbook from

Returns:

HTTP Response