org.treetank.service.jaxrx.implementation

Class DatabaseRepresentation

java.lang.Object

org.treetank.service.jaxrx.implementation.DatabaseRepresentation

public class DatabaseRepresentation
extends Object

This class is the TreeTank DB connection for RESTful Web Services processing. When a RESTful WS database request occurs it will be forwarded to TreeTank to manage the request. Here XML files can be shredded and serialized to build the client response. Further more it supports XPath queries.

Author:

Patrick Lang, Lukas Lewandowski, Sebastian Graf University of Konstanz

Constructor Summary

Constructors

Constructor and Description
DatabaseRepresentation(IStorage pDatabase, IBackend.IBackendFactory pStorageFac, IRevisioning pRevision)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(InputStream input, String resource) This method is responsible to add a new XML document to a collection.
void	createResource(InputStream inputStream, String resourceName) This method is responsible to create a new database.
void	deleteResource(String resourceName) This method is responsible to delete an existing database.
long	getLastRevision(String resourceName) This method reads the existing database, and offers the last revision id of the database
OutputStream	getModificHistory(String resourceName, String revisionRange, boolean nodeid, OutputStream output, boolean wrap) This method reads the existing database, and offers all modifications of the two given revisions
javax.ws.rs.core.StreamingOutput	getResource(String resourceName, Map<QueryParameter,String> queryParams) This method is responsible to deliver the whole database.
javax.ws.rs.core.StreamingOutput	getResourcesNames() This method is responsible to deliver a list of available resources and collections supported by TreeTank's REST implementation.
javax.ws.rs.core.StreamingOutput	performQueryOnResource(String resource, String query, Map<QueryParameter,String> otherParams) This method is responsible to perform queries on a special database.
void	revertToRevision(String resourceName, long backToRevision) This method reverts the latest revision data to the requested.
boolean	shred(InputStream xmlInput, String resource) This method is responsible to save the XML file, which is in an InputStream, as a TreeTank object.

Methods inherited from class java.lang.Object

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

Constructor Detail

DatabaseRepresentation

public DatabaseRepresentation(IStorage pDatabase,
                      IBackend.IBackendFactory pStorageFac,
                      IRevisioning pRevision)
                       throws TTException

Throws:

TTException

Method Detail

createResource

public void createResource(InputStream inputStream,
                  String resourceName)
                    throws JaxRxException

This method is responsible to create a new database.

Parameters:

inputStream - The stream containing the XML document that has to be stored.

resourceName - The name of the new database.

Throws:

JaxRxException - The exception occurred.

getResource

public javax.ws.rs.core.StreamingOutput getResource(String resourceName,
                                           Map<QueryParameter,String> queryParams)
                                             throws JaxRxException

This method is responsible to deliver the whole database. Additional parameters can be set (wrap, revision, output) which change the response view.

Parameters:

resourceName - The name of the requested database.

queryParams - The optional query parameters.

Returns:

The XML database resource, depending on the query parameters.

Throws:

JaxRxException - The exception occurred.

performQueryOnResource

public javax.ws.rs.core.StreamingOutput performQueryOnResource(String resource,
                                                      String query,
                                                      Map<QueryParameter,String> otherParams)

This method is responsible to perform queries on a special database. (XPath queries).

Parameters:

resource - The name of the database instance.

query - The XPath expression.

otherParams - Further query parameters (output, wrap, revision) which change the response.

Returns:

The result of the XPath query expression.

getResourcesNames

public javax.ws.rs.core.StreamingOutput getResourcesNames()
                                                   throws JaxRxException

This method is responsible to deliver a list of available resources and collections supported by TreeTank's REST implementation.

Returns:

The list of available databases and collections wrapped in an XML document.

Throws:

JaxRxException - The exception occurred.

add

public void add(InputStream input,
       String resource)
         throws JaxRxException

This method is responsible to add a new XML document to a collection.

Parameters:

input - The new XML document packed in an InputStream.

resource - The name of the collection.

Throws:

JaxRxException - The exception occurred.

deleteResource

public void deleteResource(String resourceName)
                    throws javax.ws.rs.WebApplicationException

This method is responsible to delete an existing database.

Parameters:

resourceName - The name of the database.

Throws:

javax.ws.rs.WebApplicationException - The exception occurred.

shred

public final boolean shred(InputStream xmlInput,
            String resource)
                    throws TTException

This method is responsible to save the XML file, which is in an InputStream, as a TreeTank object.

Parameters:

xmlInput - The XML file in an InputStream.

resource - The name of the resource.

Returns:

true when the shredding process has been successful. false otherwise.

Throws:

TTException

getLastRevision

public long getLastRevision(String resourceName)
                     throws JaxRxException,
                            TTException

This method reads the existing database, and offers the last revision id of the database

Parameters:

resourceName - The name of the existing database.

Returns:

The OutputStream containing the result

Throws:

javax.ws.rs.WebApplicationException - The Exception occurred.

TTException

JaxRxException

getModificHistory

public OutputStream getModificHistory(String resourceName,
                             String revisionRange,
                             boolean nodeid,
                             OutputStream output,
                             boolean wrap)
                               throws JaxRxException,
                                      TTException

This method reads the existing database, and offers all modifications of the two given revisions

Parameters:

resourceName - The name of the existing database.

revisionRange - Contains the range of revisions

nodeid - To response the resource with a restid for each node ( true) or without ( false).

output - The OutputStream reference which have to be modified and returned

wrap - true if the results have to be wrapped. false otherwise.

Returns:

The OutputStream containing the result

Throws:

TTException

javax.ws.rs.WebApplicationException - The Exception occurred.

JaxRxException

revertToRevision

public void revertToRevision(String resourceName,
                    long backToRevision)
                      throws JaxRxException,
                             TTException

This method reverts the latest revision data to the requested.

Parameters:

resourceName - The name of the XML resource.

backToRevision - The revision value, which has to be set as the latest.

Throws:

javax.ws.rs.WebApplicationException

TTException

JaxRxException