edu.msu.nscl.olog

Class LogsResource

java.lang.Object

edu.msu.nscl.olog.LogsResource

public class LogsResource
extends Object

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

Author:

Eric Berryman taken from Ralph Lange

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	add(javax.servlet.http.HttpServletRequest req, javax.ws.rs.core.HttpHeaders headers, Logs data) POST method for creating multiple log instances.
javax.ws.rs.core.Response	create(javax.servlet.http.HttpServletRequest req, javax.ws.rs.core.HttpHeaders headers, Long logId, Log data) PUT method for editing a log instance identified by the payload.
javax.ws.rs.core.Response	query() GET method for retrieving a collection of Log instances, based on a multi-parameter query specifying patterns for tag and logbook details to match against.
javax.ws.rs.core.Response	read(Long logId) GET method for retrieving an instance of Log identified by id.
javax.ws.rs.core.Response	remove(Long logId) DELETE method for deleting a log instance identified by path parameter id.
javax.ws.rs.core.Response	update(javax.servlet.http.HttpServletRequest req, javax.ws.rs.core.HttpHeaders headers, Long logId, Log data) POST method for merging logbooks and tags of the Log identified by the payload into an existing log.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogsResource

public LogsResource()

Creates a new instance of LogsResource

Method Detail

query

public javax.ws.rs.core.Response query()
                                throws javax.jcr.RepositoryException,
                                       UnsupportedEncodingException,
                                       NoSuchAlgorithmException

GET method for retrieving a collection of Log instances, based on a multi-parameter query specifying patterns for tag and logbook details to match against.

Returns:

HTTP Response

Throws:

javax.jcr.RepositoryException

UnsupportedEncodingException

NoSuchAlgorithmException

add

public javax.ws.rs.core.Response add(@Context
                            javax.servlet.http.HttpServletRequest req,
                            @Context
                            javax.ws.rs.core.HttpHeaders headers,
                            Logs data)
                              throws IOException,
                                     UnsupportedEncodingException,
                                     NoSuchAlgorithmException,
                                     NamingException,
                                     javax.jcr.RepositoryException

POST method for creating multiple log instances.

Parameters:

data - Logs data (from payload)

Returns:

HTTP Response

Throws:

IOException - when audit or log fail

UnsupportedEncodingException

NoSuchAlgorithmException

NamingException

javax.jcr.RepositoryException

read

public javax.ws.rs.core.Response read(Long logId)
                               throws UnsupportedEncodingException,
                                      NoSuchAlgorithmException

GET method for retrieving an instance of Log identified by id.

Parameters:

logId - log id

Returns:

HTTP Response

Throws:

UnsupportedEncodingException

NoSuchAlgorithmException

create

public javax.ws.rs.core.Response create(@Context
                               javax.servlet.http.HttpServletRequest req,
                               @Context
                               javax.ws.rs.core.HttpHeaders headers,
                               Long logId,
                               Log data)
                                 throws UnsupportedEncodingException,
                                        NoSuchAlgorithmException

PUT method for editing a log instance identified by the payload. The complete set of logbooks/tags for the log must be supplied, which will replace the existing set of logbooks/tags.

Parameters:

logId - id of log to edit

data - new data (logbooks/tags) for log id

Returns:

HTTP response

Throws:

UnsupportedEncodingException

NoSuchAlgorithmException

update

public javax.ws.rs.core.Response update(@Context
                               javax.servlet.http.HttpServletRequest req,
                               @Context
                               javax.ws.rs.core.HttpHeaders headers,
                               Long logId,
                               Log data)
                                 throws UnsupportedEncodingException,
                                        NoSuchAlgorithmException

POST method for merging logbooks and tags of the Log identified by the payload into an existing log.

Parameters:

logId - id of log to add

data - new Log data (logbooks/tags) to be merged into log id

Returns:

HTTP response

Throws:

UnsupportedEncodingException

NoSuchAlgorithmException

remove

public javax.ws.rs.core.Response remove(Long logId)
                                 throws UnsupportedEncodingException,
                                        NoSuchAlgorithmException

DELETE method for deleting a log instance identified by path parameter id.

Parameters:

logId - log to remove

Returns:

HTTP Response

Throws:

UnsupportedEncodingException

NoSuchAlgorithmException