A B C D E G J M N O P Q R S T U V W X 

A

add(InputStream, ResourcePath) - Method in class org.jaxrx.dom.DOMJaxRx
 
add(InputStream, ResourcePath) - Method in interface org.jaxrx.JaxRx
This method is called by the POST method.
add(InputStream, String) - Method in class org.treetank.service.jaxrx.implementation.DatabaseRepresentation
This method is responsible to add a new XML document to a collection.
add(InputStream, ResourcePath) - Method in class org.treetank.service.jaxrx.implementation.TreeTankMediator
 
addSubResource(String, long, InputStream, EIdAccessType) - Method in class org.treetank.service.jaxrx.implementation.NodeIdRepresentation
This method is responsible to perform a POST request to a node id.

B

buildDOMResponse(List<String>) - Static method in class org.jaxrx.core.ResponseBuilder
Builds a DOM response.
buildResponseOfDomLR(IStorage, IBackend.IBackendFactory, IRevisioning) - Static method in class org.treetank.service.jaxrx.util.RESTResponseHelper
This method builds the overview for the resources and collection we offer in our implementation.

C

check(InputStream) - Method in class org.jaxrx.core.SchemaChecker
This method parses an XML input with a W3C DOM implementation and validates it then with the available XML schema.
closeRTX(INodeReadTrx, ISession) - Static method in class org.treetank.service.jaxrx.util.WorkerHelper
This method closes all open treetank connections concerning a NodeReadTrx.
closeWTX(boolean, INodeWriteTrx, ISession) - Static method in class org.treetank.service.jaxrx.util.WorkerHelper
This method closes all open treetank connections concerning a NodeWriteTrx.
command(String, ResourcePath) - Method in class org.jaxrx.dom.DOMJaxRx
 
command(String, ResourcePath) - Method in interface org.jaxrx.JaxRx
This method is called by the GET and the POST method, if QueryParameter.COMMAND was specified in the HTTP request.
command(String, ResourcePath) - Method in class org.treetank.service.jaxrx.implementation.TreeTankMediator
 
createReader(InputStream) - Static method in class org.treetank.service.jaxrx.util.RESTXMLShredder
This method creates an XMLEventReader out of an InputStream.
createResource(InputStream, String) - Method in class org.treetank.service.jaxrx.implementation.DatabaseRepresentation
This method is responsible to create a new database.
createStream(Document) - Static method in class org.jaxrx.core.ResponseBuilder
Creates an output stream from the specified document.
createStringBuilderObject() - Method in class org.treetank.service.jaxrx.util.WorkerHelper
This method creates a new StringBuilder reference

D

DatabaseRepresentation - Class in org.treetank.service.jaxrx.implementation
This class is the TreeTank DB connection for RESTful Web Services processing.
DatabaseRepresentation(IStorage, IBackend.IBackendFactory, IRevisioning) - Constructor for class org.treetank.service.jaxrx.implementation.DatabaseRepresentation
 
delete(ResourcePath) - Method in class org.jaxrx.dom.DOMJaxRx
 
delete(ResourcePath) - Method in interface org.jaxrx.JaxRx
This method is called by the DELETE method.
delete(ResourcePath) - Method in class org.treetank.service.jaxrx.implementation.TreeTankMediator
 
deleteResource(String, String, HttpHeaders) - Method in class org.jaxrx.resource.XMLResource
This method will be called when an HTTP client sends a DELETE request to delete an existing resource.
deleteResource(String) - Method in class org.treetank.service.jaxrx.implementation.DatabaseRepresentation
This method is responsible to delete an existing database.
deleteResource(String, long) - Method in class org.treetank.service.jaxrx.implementation.NodeIdRepresentation
This method is responsible to delete an XML resource addressed through a unique node id (except root node id).
DOMJaxRx - Class in org.jaxrx.dom
 
DOMJaxRx() - Constructor for class org.jaxrx.dom.DOMJaxRx
 

E

EIdAccessType - Enum in org.treetank.service.jaxrx.enums
This Enum class offers the available set of HTTP method node id resource access types.

G

get(ResourcePath) - Method in class org.jaxrx.dom.DOMJaxRx
 
get(ResourcePath) - Method in interface org.jaxrx.JaxRx
This method is called by the GET and the POST method.
get(ResourcePath) - Method in class org.treetank.service.jaxrx.implementation.TreeTankMediator
 
getDepth() - Method in class org.jaxrx.core.ResourcePath
Returns the depth of the resource path.
getHttpHeaders() - Method in class org.jaxrx.core.ResourcePath
Return HTTP headers from user request.
getInstance(String) - Static method in class org.jaxrx.core.Systems
Returns the instance for the specified implementation.
getInstance() - Static method in class org.treetank.service.jaxrx.util.WorkerHelper
This method return the singleton instance.
getLastRevision(String) - Method in class org.treetank.service.jaxrx.implementation.DatabaseRepresentation
This method reads the existing database, and offers the last revision id of the database
getModificHistory(String, String, boolean, OutputStream, boolean) - Method in class org.treetank.service.jaxrx.implementation.DatabaseRepresentation
This method reads the existing database, and offers all modifications of the two given revisions
getParameters() - Method in class org.jaxrx.dom.DOMJaxRx
 
getParameters() - Method in interface org.jaxrx.JaxRx
This method returns all query parameters which are supported by the implementation.
getParameters() - Method in class org.treetank.service.jaxrx.implementation.TreeTankMediator
 
getQueryParameter() - Method in class org.jaxrx.core.ResourcePath
This map return all available query parameters.
getResource(int) - Method in class org.jaxrx.core.ResourcePath
Returns the resource at the specified level.
getResource(String, UriInfo, HttpHeaders) - Method in class org.jaxrx.resource.JaxRxResource
This method returns a collection of available resources.
getResource(String, String, UriInfo, HttpHeaders) - Method in class org.jaxrx.resource.XMLResource
This method returns a collection of available resources.
getResource(String, Map<QueryParameter, String>) - Method in class org.treetank.service.jaxrx.implementation.DatabaseRepresentation
This method is responsible to deliver the whole database.
getResource(String, long, Map<QueryParameter, String>) - Method in class org.treetank.service.jaxrx.implementation.NodeIdRepresentation
This method is responsible to deliver the whole XML resource addressed by a unique node id.
getResourceByAT(String, long, Map<QueryParameter, String>, EIdAccessType) - Method in class org.treetank.service.jaxrx.implementation.NodeIdRepresentation
This method is responsible to deliver the whole XML resource addressed by a unique node id.
getResourcePath() - Method in class org.jaxrx.core.ResourcePath
Returns the complete resource path string.
getResourcesNames() - Method in class org.treetank.service.jaxrx.implementation.DatabaseRepresentation
This method is responsible to deliver a list of available resources and collections supported by TreeTank's REST implementation.
getRoot() - Method in class org.jaxrx.resource.JaxRxResource
This method waits for calls to the above specified URL JaxRxConstants.ROOTPATH and creates a response XML file containing the available further resources.
getSystem(String) - Method in class org.jaxrx.resource.JaxRxResource
This method waits for calls to the specified URL JaxRxConstants.SYSTEMPATH and creates a response XML file containing the available further resources.
getSystems() - Static method in class org.jaxrx.core.Systems
Getting all available systems as keys and implementing packages as values.
getValue(QueryParameter) - Method in class org.jaxrx.core.ResourcePath
Returns the value of the specified query parameter, or null if no value is mapped.
getXpathResource(String, String, boolean, Long, OutputStream, boolean) - Method in class org.treetank.service.jaxrx.util.RestXPathProcessor
Getting part of the XML based on a XPath query
getXpathResource(String, long, String, boolean, Long, OutputStream, boolean) - Method in class org.treetank.service.jaxrx.util.RestXPathProcessor
Getting part of the XML based on a XPath query

J

JAXRX - Static variable in class org.jaxrx.core.JaxRxConstants
Name of JAX-RX resource.
JaxRx - Interface in org.jaxrx
This interface assembles all interface methods for the GET, POST, PUT and DELETE requests.
JaxRxConstants - Class in org.jaxrx.core
This class contains constants, which are used throughout the JAX-RX interface and implementations.
JaxRxException - Exception in org.jaxrx.core
An exception that is either thrown by the JAX-RX interface or its underlying implementation.
JaxRxException(int, String) - Constructor for exception org.jaxrx.core.JaxRxException
Constructs a new exception with the given HTTP status code and status message.
JaxRxException(Exception) - Constructor for exception org.jaxrx.core.JaxRxException
Constructor, wrapping the specified exception and setting 500 as HTTP status code.
JaxRxException(Response) - Constructor for exception org.jaxrx.core.JaxRxException
Constructor, using a Response reference.
JAXRXPATH - Static variable in class org.jaxrx.core.JaxRxConstants
The path of the rest path within JAX-RX.
JaxRxResource - Class in org.jaxrx.resource
This class processes HTTP requests for the JAX-RX general URL part: /{system}/jax-rx/}.
JaxRxResource() - Constructor for class org.jaxrx.resource.JaxRxResource
 
JettyServer - Class in org.jaxrx
This is the main class to start the Jetty server to offer RESTful web services support.
JettyServer(int) - Constructor for class org.jaxrx.JettyServer
Constructor, creating and starting a new server.

M

main(String[]) - Static method in class org.treetank.service.jaxrx.server.StartServer
This method starts the embedded Jetty server.
MEDIATYPE - Static variable in class org.jaxrx.core.JaxRxConstants
Output media-type parameter.
METHOD - Static variable in class org.jaxrx.core.JaxRxConstants
Output method parameter.
METHODS - Static variable in class org.jaxrx.core.JaxRxConstants
Support output methods.
modifyResource(String, long, InputStream) - Method in class org.treetank.service.jaxrx.implementation.NodeIdRepresentation
This method is responsible to modify the XML resource, which is addressed through a unique node id.

N

NAMEPROP - Static variable in class org.jaxrx.core.JaxRxConstants
System name property.
NodeIdRepresentation - Class in org.treetank.service.jaxrx.implementation
This class is responsible to work with database specific XML node id's.
NodeIdRepresentation(IStorage) - Constructor for class org.treetank.service.jaxrx.implementation.NodeIdRepresentation
Constructor.

O

org.jaxrx - package org.jaxrx
This is the main package for the JAX-RX interface.
org.jaxrx.core - package org.jaxrx.core
This package contains constants for the JAX-RX interface.
org.jaxrx.dom - package org.jaxrx.dom
This package contains an exemplary DOM implementation for the JAX-RX interface.
org.jaxrx.resource - package org.jaxrx.resource
 
org.treetank.service.jaxrx - package org.treetank.service.jaxrx
Root package for all packages.
org.treetank.service.jaxrx.enums - package org.treetank.service.jaxrx.enums
Enums for relative access types Used to access relative nodes via URL e.g., for fist child of a resource: http://localhost:8093/treetank/factbook/firstChild()
org.treetank.service.jaxrx.implementation - package org.treetank.service.jaxrx.implementation
Resource implementation This package contains classes which handles request for database resources and database subresources like in our case: node id support.
org.treetank.service.jaxrx.server - package org.treetank.service.jaxrx.server
Server implementation This package contains classes to configure the in JAX-RX included Jetty server to support a REST layer for the database.
org.treetank.service.jaxrx.util - package org.treetank.service.jaxrx.util
Util classes This package contains util classes for REST resources support.

P

PATHPROP - Static variable in class org.jaxrx.core.JaxRxConstants
System path property.
performQueryOnResource(String, String, Map<QueryParameter, String>) - Method in class org.treetank.service.jaxrx.implementation.DatabaseRepresentation
This method is responsible to perform queries on a special database.
performQueryOnResource(String, long, String, Map<QueryParameter, String>) - Method in class org.treetank.service.jaxrx.implementation.NodeIdRepresentation
This method is responsible to perform a XPath query expression on the XML resource which is addressed through a unique node id.
postQuery(String, InputStream, HttpHeaders) - Method in class org.jaxrx.resource.JaxRxResource
This method will be called when a HTTP client sends a POST request to an existing resource with 'application/query+xml' as Content-Type.
postQuery(String, String, HttpHeaders, InputStream) - Method in class org.jaxrx.resource.XMLResource
This method will be called when a HTTP client sends a POST request to an existing resource with 'application/query+xml' as Content-Type.
postResource(String, String, HttpHeaders, InputStream) - Method in class org.jaxrx.resource.XMLResource
This method will be called when an HTTP client sends a POST request to an existing resource to add a resource.
putResource(String, String, HttpHeaders, InputStream) - Method in class org.jaxrx.resource.XMLResource
This method will be called when a new XML file has to be stored within the database.

Q

query(String, ResourcePath) - Method in class org.jaxrx.dom.DOMJaxRx
 
query(String, ResourcePath) - Method in interface org.jaxrx.JaxRx
This method is called by the GET and the POST method, if QueryParameter.QUERY was specified in the HTTP request.
query(String, ResourcePath) - Method in class org.treetank.service.jaxrx.implementation.TreeTankMediator
 
QueryParameter - Enum in org.jaxrx.core
This class lists all available JAX-RX query parameters.

R

register(Server) - Static method in class org.jaxrx.JettyServer
Constructor, attaching JAX-RX to the specified server.
RESOURCE - Static variable in class org.jaxrx.core.JaxRxConstants
Name of resource itself.
RESOURCEPATH - Static variable in class org.jaxrx.core.JaxRxConstants
The path of the variable resource path, depending on the available resources.
ResourcePath - Class in org.jaxrx.core
This class contains information on the resource path and query parameters of a JAX-RX request.
ResourcePath(String) - Constructor for class org.jaxrx.core.ResourcePath
Constructs a new ResourcePath.
ResourcePath(String, Map<QueryParameter, String>) - Constructor for class org.jaxrx.core.ResourcePath
Constructs a new ResourcePath with an additional QueryParameter map.
ResourcePath(String, HttpHeaders) - Constructor for class org.jaxrx.core.ResourcePath
Constructs a new ResourcePath with an additional QueryParameter map.
ResourcePath(String, Map<QueryParameter, String>, HttpHeaders) - Constructor for class org.jaxrx.core.ResourcePath
Constructs a new ResourcePath with an additional QueryParameter map.
ResponseBuilder - Class in org.jaxrx.core
This class builds the response XML fragments for JAX-RX resources.
RESTResponseHelper - Class in org.treetank.service.jaxrx.util
This class is a helper class to build the response XML fragment for REST resources.
RESTXMLShredder - Class in org.treetank.service.jaxrx.util
This class is responsible to create a TreeTank XMLStreamReader out of an InputStream.
RestXPathProcessor - Class in org.treetank.service.jaxrx.util
This class is responsible to offer XPath processing functions for REST.
RestXPathProcessor(IStorage) - Constructor for class org.treetank.service.jaxrx.util.RestXPathProcessor
Constructor.
revertToRevision(String, long) - Method in class org.treetank.service.jaxrx.implementation.DatabaseRepresentation
This method reverts the latest revision data to the requested.
ROOTPATH - Static variable in class org.jaxrx.core.JaxRxConstants
The root path.
run(String, ResourcePath) - Method in class org.jaxrx.dom.DOMJaxRx
 
run(String, ResourcePath) - Method in interface org.jaxrx.JaxRx
This method is called by the GET and the POST method, if QueryParameter.RUN was specified in the HTTP request.
run(String, ResourcePath) - Method in class org.treetank.service.jaxrx.implementation.TreeTankMediator
 

S

SchemaChecker - Class in org.jaxrx.core
This class validates XML documents against a specified XML schema.
SchemaChecker(String) - Constructor for class org.jaxrx.core.SchemaChecker
Constructor.
serializeXML(ISession, OutputStream, boolean, boolean, Long) - Static method in class org.treetank.service.jaxrx.util.WorkerHelper
This method creates a new XMLSerializer reference
serializeXML(ISession, OutputStream, boolean, boolean, Long, Long) - Static method in class org.treetank.service.jaxrx.util.WorkerHelper
This method creates a new XMLSerializer reference
shred(InputStream, String) - Method in class org.treetank.service.jaxrx.implementation.DatabaseRepresentation
This method is responsible to save the XML file, which is in an InputStream, as a TreeTank object.
shredInputStream(INodeWriteTrx, InputStream, EShredderInsert) - Static method in class org.treetank.service.jaxrx.util.WorkerHelper
Shreds a given InputStream
StartServer - Class in org.treetank.service.jaxrx.server
This class starts the in JAX-RX embedded Jetty server.
StartServer(int) - Constructor for class org.treetank.service.jaxrx.server.StartServer
I'm a lazy constructor.
stop() - Method in class org.jaxrx.JettyServer
Stops the server.
stopServer() - Method in class org.treetank.service.jaxrx.server.StartServer
This method stops the Jetty server.
SYSTEM - Static variable in class org.jaxrx.core.JaxRxConstants
The path of the underlying system.
SYSTEMPATH - Static variable in class org.jaxrx.core.JaxRxConstants
The path of the underlying system.
Systems - Class in org.jaxrx.core
This class organizes all implementations of the JAX-RX interface.

T

toString() - Method in class org.jaxrx.core.ResourcePath
 
TreeTankMediator - Class in org.treetank.service.jaxrx.implementation
This class works as mediator between the JAX-RX REST interface layer and the responsible Treetank implementation class.
TreeTankMediator() - Constructor for class org.treetank.service.jaxrx.implementation.TreeTankMediator
Constructor.

U

update(InputStream, ResourcePath) - Method in class org.jaxrx.dom.DOMJaxRx
 
update(InputStream, ResourcePath) - Method in interface org.jaxrx.JaxRx
This method is called by the PUT method.
update(InputStream, ResourcePath) - Method in class org.treetank.service.jaxrx.implementation.TreeTankMediator
 
URL - Static variable in class org.jaxrx.core.JaxRxConstants
The interface URL.

V

validateAccessType(String) - Method in class org.treetank.service.jaxrx.util.WorkerHelper
This method checks the variable URL path after the node id resource (e.g.
valueOf(String) - Static method in enum org.jaxrx.core.QueryParameter
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.treetank.service.jaxrx.enums.EIdAccessType
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.jaxrx.core.QueryParameter
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.treetank.service.jaxrx.enums.EIdAccessType
Returns an array containing the constants of this enum type, in the order they are declared.

W

WorkerHelper - Class in org.treetank.service.jaxrx.util
This class contains methods that are respectively used by this worker classes (NodeIdRepresentation.java and DatabaseRepresentation.java)

X

XMLResource - Class in org.jaxrx.resource
This class match HTTP requests for the JaxRxConstants.RESOURCEPATH.
XMLResource() - Constructor for class org.jaxrx.resource.XMLResource
 
A B C D E G J M N O P Q R S T U V W X 

Copyright © 2013. All Rights Reserved.