org.jaxrx.resource

Class XMLResource

java.lang.Object

org.jaxrx.resource.XMLResource

public final class XMLResource
extends Object

This class match HTTP requests for the JaxRxConstants.RESOURCEPATH. This means that JAX-RX returns the available resources which the underlying implementation provide. Available resources could be collections or particular XML resources.

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
XMLResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteResource(String system, String resource, javax.ws.rs.core.HttpHeaders headers) This method will be called when an HTTP client sends a DELETE request to delete an existing resource.
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, String resource, 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.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.
javax.ws.rs.core.Response	postQuery(String system, String resource, javax.ws.rs.core.HttpHeaders headers, InputStream input) 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	postResource(String system, String resource, javax.ws.rs.core.HttpHeaders headers, InputStream input) This method will be called when an HTTP client sends a POST request to an existing resource to add a resource.
javax.ws.rs.core.Response	putResource(String system, String resource, javax.ws.rs.core.HttpHeaders headers, InputStream xml) This method will be called when a new XML file has to be stored within the database.

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

XMLResource

public XMLResource()

Method Detail

getResource

public javax.ws.rs.core.Response getResource(String system,
                                    String resource,
                                    @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.

resource - The name of the requested resource.

uri - The context information due to the requested URI.

headers - HttpHeaders information.

Returns:

A collection of available resources.

postQuery

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

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.

resource - The resource name.

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.

postResource

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

This method will be called when an HTTP client sends a POST request to an existing resource to add a resource. Content-Type must be 'text/xml'.

Parameters:

system - The implementation system.

resource - The resource name.

headers - HTTP header attributes.

input - The input stream.

Returns:

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

putResource

public javax.ws.rs.core.Response putResource(String system,
                                    String resource,
                                    @Context
                                    javax.ws.rs.core.HttpHeaders headers,
                                    InputStream xml)

This method will be called when a new XML file has to be stored within the database. The user request will be forwarded to this method. Afterwards it creates a response message with the 'created' HTTP status code, if the storing has been successful.

Parameters:

system - The associated system with this request.

resource - The name of the new resource.

headers - HTTP header attributes.

xml - The XML file as InputStream that will be stored.

Returns:

The HTTP status code as response.

deleteResource

public javax.ws.rs.core.Response deleteResource(String system,
                                       String resource,
                                       @Context
                                       javax.ws.rs.core.HttpHeaders headers)

This method will be called when an HTTP client sends a DELETE request to delete an existing resource.

Parameters:

system - The associated system with this request.

resource - The name of the existing resource that has to be deleted.

headers - HTTP header attributes.

Returns:

The HTTP response code for this call.

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.