org.treetank.service.jaxrx.implementation

Class TreeTankMediator

java.lang.Object

org.treetank.service.jaxrx.implementation.TreeTankMediator

All Implemented Interfaces:

JaxRx

public final class TreeTankMediator
extends Object
implements JaxRx

This class works as mediator between the JAX-RX REST interface layer and the responsible Treetank implementation class. It checks the requested resource path and forwards it then to the responsible one.

Author:

Lukas Lewandowski, University of Konstanz

Constructor Summary

Constructors

Constructor and Description
TreeTankMediator() Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	add(InputStream input, ResourcePath path) This method is called by the POST method.
javax.ws.rs.core.StreamingOutput	command(String command, ResourcePath path) This method is called by the GET and the POST method, if QueryParameter.COMMAND was specified in the HTTP request.
String	delete(ResourcePath path) This method is called by the DELETE method.
javax.ws.rs.core.StreamingOutput	get(ResourcePath path) This method is called by the GET and the POST method.
Set<QueryParameter>	getParameters() This method returns all query parameters which are supported by the implementation.
javax.ws.rs.core.StreamingOutput	query(String query, ResourcePath path) This method is called by the GET and the POST method, if QueryParameter.QUERY was specified in the HTTP request.
javax.ws.rs.core.StreamingOutput	run(String file, ResourcePath path) This method is called by the GET and the POST method, if QueryParameter.RUN was specified in the HTTP request.
String	update(InputStream input, ResourcePath path) This method is called by the PUT method.

Methods inherited from class java.lang.Object

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

Constructor Detail

TreeTankMediator

public TreeTankMediator()
                 throws TTException

Constructor.

Throws:

TTException

Method Detail

add

public String add(InputStream input,
         ResourcePath path)
           throws JaxRxException

Description copied from interface: JaxRx

This method is called by the POST method. A new resource is added to the specified resource path.

Specified by:

add in interface JaxRx

Parameters:

input - The object containing the new content.

path - Resource and parameter info

Returns:

info message

Throws:

JaxRxException - thrown if

• the specified resource does not exist (status code: 404)
• if the input is invalid (status code: 400)
• an unexpected exception occurs (status code: 500)

command

public javax.ws.rs.core.StreamingOutput command(String command,
                                       ResourcePath path)
                                         throws JaxRxException

Description copied from interface: JaxRx

This method is called by the GET and the POST method, if QueryParameter.COMMAND was specified in the HTTP request. This method performs a database command, based on the given resource path.

Specified by:

command in interface JaxRx

Parameters:

command - The command to be executed

path - Resource and parameter info

Returns:

The StreamingOutput containing the query output.

Throws:

JaxRxException - thrown if

• the specified resource does not exist (code 404)
• the specified parameters are invalid or the command execution yields errors (code 400)
• an unexpected exception occurs (code 500)

update

public String update(InputStream input,
            ResourcePath path)
              throws JaxRxException

Description copied from interface: JaxRx

This method is called by the PUT method. A new resource is created at the specified resource path. If the resource already exists, it is replaced by the new resource.

Specified by:

update in interface JaxRx

Parameters:

input - The incoming InputStream.

path - Resource and parameter info

Returns:

info message

Throws:

JaxRxException - thrown if

• the input was invalid (status code: 400)
• an unexpected exception occurred (status code: 500)

delete

public String delete(ResourcePath path)
              throws JaxRxException

Description copied from interface: JaxRx

This method is called by the DELETE method. An existing resource is deleted, which is specified by the resource path.

Specified by:

delete in interface JaxRx

Parameters:

path - Resource and parameter info

Returns:

info message

Throws:

JaxRxException - thrown if

• the resource was not found (status code: 404)
• an unexpected exception occurred (status code: 500)

get

public javax.ws.rs.core.StreamingOutput get(ResourcePath path)
                                     throws JaxRxException

Description copied from interface: JaxRx

This method is called by the GET and the POST method. The specified resource is returned. If no resource is specified, the root is returned, which can e.g. comprise a list of all resources.

Specified by:

get in interface JaxRx

Parameters:

path - Resource and parameter info

Returns:

The StreamingOutput containing the query output.

Throws:

JaxRxException - thrown if

• the specified resource does not exist (status code: 404)
• an unexpected exception occurs (status code: 500)

getParameters

public Set<QueryParameter> getParameters()

Description copied from interface: JaxRx

This method returns all query parameters which are supported by the implementation.

Specified by:

getParameters in interface JaxRx

Returns:

The Set containing the allowed parameters specified in QueryParameter.

query

public javax.ws.rs.core.StreamingOutput query(String query,
                                     ResourcePath path)
                                       throws JaxRxException

Description copied from interface: JaxRx

This method is called by the GET and the POST method, if QueryParameter.QUERY was specified in the HTTP request. This method performs a query, based on the given resource path.

Specified by:

query in interface JaxRx

Parameters:

query - The query to be executed

path - Resource and parameter info

Returns:

The StreamingOutput containing the query output.

Throws:

JaxRxException - thrown if

• the specified resource does not exist (status code: 404)
• the specified parameters are invalid or the query execution yields errors (status code: 400)
• an unexpected exception occurs (status code: 500)

run

public javax.ws.rs.core.StreamingOutput run(String file,
                                   ResourcePath path)
                                     throws JaxRxException

Description copied from interface: JaxRx

This method is called by the GET and the POST method, if QueryParameter.RUN was specified in the HTTP request. This method runs a server-side query file, based on the given resource path.

Specified by:

run in interface JaxRx

Parameters:

file - The file to be run

path - Resource and parameter info

Returns:

The StreamingOutput containing the query output

Throws:

JaxRxException - thrown if

• the specified resource or query file does not exist (status code: 404)
• the specified parameters are invalid or the command execution yields errors (status code: 400)
• an unexpected exception occurs (status code: 500)