org.jaxrx.resource

Class JaxRxResource

java.lang.Object

org.jaxrx.resource.JaxRxResource

public final class JaxRxResource
extends Object

This class processes HTTP requests for the JAX-RX general URL part: /{system}/jax-rx/}. Depending on which part of the URL a request occurs, it creates a HTTP response containing the available resources according to the URL path.

Author:

Sebastian Graf, Christian Gruen, Lukas Lewandowski, University of Konstanz

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	APPLICATION_QUERY_XML Content type for query expressions.

Constructor Summary

Constructors

Constructor and Description
JaxRxResource()

Method Summary

Methods

Modifier and Type	Method and Description
protected Map<QueryParameter,String>	getParameters(Document doc, JaxRx jaxrx) Extracts and returns query parameters, variables, and output options from the specified document instance.
protected Map<QueryParameter,String>	getParameters(javax.ws.rs.core.UriInfo uri, JaxRx jaxrx) Extracts and returns query parameters from the specified map.
javax.ws.rs.core.Response	getResource(String system, javax.ws.rs.core.UriInfo uri, javax.ws.rs.core.HttpHeaders headers) This method returns a collection of available resources.
javax.ws.rs.core.Response	getResource(String system, javax.ws.rs.core.UriInfo uri, String resource, javax.ws.rs.core.HttpHeaders headers) This method will be called when a HTTP client sends a POST request to an existing resource with 'application/query+xml' as Content-Type.
javax.ws.rs.core.StreamingOutput	getRoot() This method waits for calls to the above specified URL JaxRxConstants.ROOTPATH and creates a response XML file containing the available further resources.
javax.ws.rs.core.StreamingOutput	getSystem(String system) This method waits for calls to the specified URL JaxRxConstants.SYSTEMPATH and creates a response XML file containing the available further resources.
javax.ws.rs.core.Response	postQuery(String system, InputStream input, javax.ws.rs.core.HttpHeaders headers) This method will be called when a HTTP client sends a POST request to an existing resource with 'application/query+xml' as Content-Type.
javax.ws.rs.core.Response	postQuery(String system, InputStream input, String resource, javax.ws.rs.core.HttpHeaders httpHeaders) This method will be called when a HTTP client sends a POST request to an existing resource with 'application/query+xml' as Content-Type.

Methods inherited from class java.lang.Object

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

Field Detail

APPLICATION_QUERY_XML

protected static final String APPLICATION_QUERY_XML

Content type for query expressions.

See Also:

Constant Field Values

Constructor Detail

JaxRxResource

public JaxRxResource()

Method Detail

getRoot

public javax.ws.rs.core.StreamingOutput getRoot()

This method waits for calls to the above specified URL JaxRxConstants.ROOTPATH and creates a response XML file containing the available further resources. In our case it is just the JaxRxConstants.SYSTEMPATH resource.

Returns:

The available resources according to the URL path.

getSystem

public javax.ws.rs.core.StreamingOutput getSystem(String system)

This method waits for calls to the specified URL JaxRxConstants.SYSTEMPATH and creates a response XML file containing the available further resources. In our case it just the JaxRxConstants.JAXRXPATH resource.

Parameters:

system - The associated system with this request.

Returns:

The available resources resources according to the URL path.

getResource

public javax.ws.rs.core.Response getResource(String system,
                                    @Context
                                    javax.ws.rs.core.UriInfo uri,
                                    @Context
                                    javax.ws.rs.core.HttpHeaders headers)

This method returns a collection of available resources. An available resource can be either a particular XML resource or a collection containing further XML resources.

Parameters:

system - The associated system with this request.

uri - The context information due to the requested URI.

headers - HTTP header attributes.

Returns:

The available resources resources according to the URL path.

postQuery

public javax.ws.rs.core.Response postQuery(String system,
                                  InputStream input,
                                  @Context
                                  javax.ws.rs.core.HttpHeaders headers)

This method will be called when a HTTP client sends a POST request to an existing resource with 'application/query+xml' as Content-Type.

Parameters:

system - The implementation system.

input - The input stream.

headers - HTTP header attributes.

Returns:

The Response which can be empty when no response is expected. Otherwise it holds the response XML file.

getParameters

protected Map<QueryParameter,String> getParameters(javax.ws.rs.core.UriInfo uri,
                                       JaxRx jaxrx)

Extracts and returns query parameters from the specified map. If a parameter is specified multiple times, its values will be separated with tab characters.

Parameters:

uri - uri info with query parameters

jaxrx - JAX-RX implementation

Returns:

The parameters as Map.

getParameters

protected Map<QueryParameter,String> getParameters(Document doc,
                                       JaxRx jaxrx)

Extracts and returns query parameters, variables, and output options from the specified document instance. The keys and values of variables are separated with the control code '\2'.

Parameters:

doc - The XML Document containing the XQuery XML post request.

jaxrx - current implementation

Returns:

The parameters as Map.

postQuery

public javax.ws.rs.core.Response postQuery(String system,
                                  InputStream input,
                                  String resource,
                                  javax.ws.rs.core.HttpHeaders httpHeaders)

This method will be called when a HTTP client sends a POST request to an existing resource with 'application/query+xml' as Content-Type.

Parameters:

system - The implementation system.

input - The input stream.

resource - The resource

httpHeaders - HTTP header attributes.

Returns:

The Response which can be empty when no response is expected. Otherwise it holds the response XML file.

getResource

public javax.ws.rs.core.Response getResource(String system,
                                    javax.ws.rs.core.UriInfo uri,
                                    String resource,
                                    javax.ws.rs.core.HttpHeaders headers)

This method will be called when a HTTP client sends a POST request to an existing resource with 'application/query+xml' as Content-Type.

Parameters:

system - The implementation system.

uri - The context information due to the requested URI.

resource - The resource

headers - HTTP header attributes.

Returns:

The Response which can be empty when no response is expected. Otherwise it holds the response XML file.