edu.msu.nscl.olog

Class PropertiesResource

java.lang.Object

edu.msu.nscl.olog.PropertiesResource

public class PropertiesResource
extends Object

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

Author:

Robert Gaul III

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	addAttribute(javax.servlet.http.HttpServletRequest req, javax.ws.rs.core.HttpHeaders headers, String property, Long logId, XmlProperty data) PUT method for adding a new properties attribute to a log entry.
javax.ws.rs.core.Response	addProperty(String newProperty, XmlProperty data) PUT method for adding a new property.
javax.ws.rs.core.Response	appendProperty(String newProperty, XmlProperty data) POST method for adding a new property.
javax.ws.rs.core.Response	listAttributes(String property) GET method for retrieving the list of attributes for a given property.
javax.ws.rs.core.Response	listProperties() GET method for retrieving the list of properties in the database.
javax.ws.rs.core.Response	removeAttribute(javax.servlet.http.HttpServletRequest req, javax.ws.rs.core.HttpHeaders headers, String property, Long logId, XmlProperty data) DELETE method for removing a properties attribute from a log entry.
javax.ws.rs.core.Response	removeProperty(String property, XmlProperty data) DELETE method for removing a property.

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertiesResource

public PropertiesResource()

Creates a new instance of PropertiesResource

Method Detail

listProperties

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

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

Returns:

addProperty

public javax.ws.rs.core.Response addProperty(String newProperty,
                                    XmlProperty data)

PUT method for adding a new property. Is destructive in nature.

Parameters:

newProperty - the property being added

data - the XML payload containing attributes to be added to the property

Returns:

listAttributes

public javax.ws.rs.core.Response listAttributes(String property)

GET method for retrieving the list of attributes for a given property.

Returns:

appendProperty

public javax.ws.rs.core.Response appendProperty(String newProperty,
                                       XmlProperty data)

POST method for adding a new property. Is not destructive as it appends attributes to those already there.

Parameters:

newProperty - the property being added

data - the XML payload containing attributes to be added to the property

Returns:

removeProperty

public javax.ws.rs.core.Response removeProperty(String property,
                                       XmlProperty data)

DELETE method for removing a property.

Parameters:

String - property property to be removed or that will contain attributes to be removed

Property - data payload containing attributes to be removed

Returns:

addAttribute

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

PUT method for adding a new properties attribute to a log entry.

Parameters:

String - newProperty the property being added

Long - logId the id of the log entry that the property is being added to

data - the XML payload containing attributes and their values to be added to be associated with the log entry

Returns:

Throws:

UnsupportedEncodingException

NoSuchAlgorithmException

removeAttribute

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

DELETE method for removing a properties attribute from a log entry.

Parameters:

String - newProperty the property being added

Long - logId the id of the log entry that the property is being added to

data - the XML payload containing attributes and their values to be removed from the log entry

Returns:

Throws:

UnsupportedEncodingException

NoSuchAlgorithmException