org.josef.demo.ws.rest.elements

Class PeriodicTableElementResource

java.lang.Object

org.josef.demo.ws.rest.elements.PeriodicTableElementResource

public class PeriodicTableElementResource
extends Object

Simple RESTful web service to maintain a single Element of the Periodic Table of the Elements.

Version:

1.0 $Revision: 6271 $

Author:

Kees Schotanus

Constructor Summary

Constructors

Constructor and Description
PeriodicTableElementResource(Long id) Constructs this PeriodicTableElementResource from the supplied id.

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createElementFromFormParameters(javax.ws.rs.core.UriInfo uriInfo, Long id, String symbol, String name, String weight, String group, String period, String block, String electronConfiguration) Creates a new Element or updates an existing Element from form parameters.
javax.ws.rs.core.Response	createOrUpdateElement(javax.ws.rs.core.UriInfo uriInfo, Element element) Creates a new Element or updates an existing Element.
javax.ws.rs.core.Response	createOrUpdateElementFromJasonOrXML(javax.ws.rs.core.UriInfo uriInfo, Element element) Creates a new Element or updates an existing Element from either JASON or XML.
void	deleteElement() Deletes the Element with the id that was supplied at construction time.
String	getElementAsHtml() Gets the Element with the id that was supplied at construction time, in HTML format.
Element	getElementAsJasonOrXml() Gets the Element with the id that was supplied at construction time.

Methods inherited from class java.lang.Object

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

Constructor Detail

PeriodicTableElementResource

public PeriodicTableElementResource(Long id)

Constructs this PeriodicTableElementResource from the supplied id.

Parameters:

id - ID of the Element.

Method Detail

getElementAsJasonOrXml

@GET
 @Produces(value={"application/json","application/xml"})
public Element getElementAsJasonOrXml()

Gets the Element with the id that was supplied at construction time.
The curl commands to get element 119 in JASON and XML format respectively are:
curl --header Accept:application/json --get http://localhost:8080/josef-demo-rest-ws/resources/elements/119
curl --header Accept:application/xml --get http://localhost:8080/josef-demo-rest-ws/resources/elements/119

Returns:

The Element with the id that was supplied at construction time, in JSON format (default) or XML format.

Throws:

javax.ws.rs.InternalServerErrorException - When the element could not be fetched from the database.

getElementAsHtml

@GET
 @Produces(value="text/html;q=0.7")
public String getElementAsHtml()

Gets the Element with the id that was supplied at construction time, in HTML format.
The curl command to get element 119 is:
curl --header Accept:text/html --get http://localhost:8080/josef-demo-rest-ws/resources/elements/119

Returns:

The Element with the id that was supplied at construction time, in HTML format.

Throws:

javax.ws.rs.InternalServerErrorException - When the element could not be fetched from the database.

createOrUpdateElementFromJasonOrXML

@PUT
 @Consumes(value={"application/json","application/xml"})
public javax.ws.rs.core.Response createOrUpdateElementFromJasonOrXML(@Context
                                                                                                                                     javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                                     Element element)

Creates a new Element or updates an existing Element from either JASON or XML.
An element is updated when the id, supplied at construction time, refers to an existing Element.
A new Element is created when no Element with the id, supplied at construction time, exists.
A PUT is used for creation of an Element as we know the URI of the created Element up front.
The curl to create Element 119 is:
curl -H "Content-Type: application/json" -T create.json http://localhost:8080/josef-demo-rest-ws/resources/elements/119
Where the create.json file would contain something like:

 {
     "id":"119",
     "name":"Element 119",
     "symbol":"Zz",
     "weight":"119.0",
     "group":"2",
     "period":"3",
     "block":"s",
     "electronConfiguration":"1s1"
 }

The curl command to update element #119 is:
curl -X PUT -d "update.json" http://localhost:8080/josef-demo-rest-ws/resources/elements/119
Where the update.json file would contain something like:

 {
     "id":"119",
     "name":"Element 119",
     "symbol":"Zz",
     "weight":"119.0",
     "group":"2",
     "period":"3",
     "block":"s",
     "electronConfiguration":"1s1"
 }

Parameters:

uriInfo - The URI Info to create links.

element - The Element.

Returns:

Upon a successful update, 204, "NO CONTENT", is returned.
When no element with the id supplied at construction time exists, 401, "NOT FOUND" is returned. When the element does exist but could not be updated, 500, "INTERNAL SERVER ERROR" is returned, including a text message describing the error.

createElementFromFormParameters

@PUT
 @Consumes(value="application/x-www-form-urlencoded")
 @Produces(value="text/plain")
public javax.ws.rs.core.Response createElementFromFormParameters(@Context
                                                                                                                                                              javax.ws.rs.core.UriInfo uriInfo,
                                                                                                                                                              @FormParam(value="id")
                                                                                                                                                              Long id,
                                                                                                                                                              @FormParam(value="idSymbol")
                                                                                                                                                              String symbol,
                                                                                                                                                              @FormParam(value="idName")
                                                                                                                                                              String name,
                                                                                                                                                              @FormParam(value="idWeight")
                                                                                                                                                              String weight,
                                                                                                                                                              @FormParam(value="idGroup")
                                                                                                                                                              String group,
                                                                                                                                                              @FormParam(value="idPeriod")
                                                                                                                                                              String period,
                                                                                                                                                              @FormParam(value="idBlock")
                                                                                                                                                              String block,
                                                                                                                                                              @FormParam(value="idElectronConfiguration")
                                                                                                                                                              String electronConfiguration)

Creates a new Element or updates an existing Element from form parameters.
An element is updated when the id, supplied at construction time, refers to an existing Element.
A new Element is created when no Element with an id, supplied at construction time, exists.
A PUT is used for creation of an Element as we know the URI of the created Element up front.

Parameters:

uriInfo - The URI Info to create links.

id - The id (atomic number).

symbol - The symbol.

name - The name.

weight - The atomic weight.

group - The group number.

period - The period number.

block - The block.

electronConfiguration - The electron configuration.

Returns:

Response with either status code 201, "CREATED" or status code 500, "INTERNAL SERVER ERROR".

createOrUpdateElement

public javax.ws.rs.core.Response createOrUpdateElement(@Context
                                                       javax.ws.rs.core.UriInfo uriInfo,
                                                       Element element)

Creates a new Element or updates an existing Element.

Parameters:

uriInfo - The URI Info Object.

element - The element to create or update.

Returns:

Response with either status code 201, "CREATED" or status code 500, "INTERNAL SERVER ERROR".

deleteElement

@DELETE
public void deleteElement()

Deletes the Element with the id that was supplied at construction time.

Throws:

javax.ws.rs.NotFoundException - When no element with the id that was supplied at construction time exists.