org.imixs.workflow.jaxrs.v40

Class DocumentRestServiceV40

java.lang.Object

org.imixs.workflow.jaxrs.v40.DocumentRestServiceV40

@Path(value="/v40/documents")
 @Produces(value={"text/html","application/xml","application/json","text/xml"})
public class DocumentRestServiceV40
extends Object

The DocumentService provides methods to access the DocumentService EJB

Author:

rsoika

Constructor Summary

Constructors

Constructor and Description
DocumentRestServiceV40()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	backup(String query, String filepath) This method creates a backup of the result set form a JQPL query.
XMLCount	countTotalHitsByQuery(String query, int maxResult) Returns a total hits for a lucene Search Query
XMLCount	countTotalPagesByQuery(String query, int pageSize) Returns the total pages for a lucene Search Query and a given page size.
javax.ws.rs.core.Response	deleteEntity(String uniqueid) This method deletes an entity
DocumentCollection	findDocumentsByJPQL(String query, int pageSize, int pageIndex, String items) Returns a resultset for a JPQL statement
DocumentCollection	findDocumentsByQuery(String query, int pageSize, int pageIndex, String sortBy, boolean sortReverse, String items) Returns a resultset for a lucene Search Query
XMLItemCollection	getConfiguration() Returns the IndexFieldListNoAnalyse from the lucensUpdateService
XMLItemCollection	getDocument(String uniqueid, String items) returns a single document defined by $uniqueid
javax.ws.rs.core.StreamingOutput	getHelpHTML()
javax.ws.rs.core.StreamingOutput	getRoot()
javax.ws.rs.core.Response	postEntity(XMLItemCollection xmlworkitem) The method saves a document provided in xml format.
javax.ws.rs.core.Response	putEntity(XMLItemCollection xmlworkitem) Delegater putEntity @PUT
javax.ws.rs.core.Response	restore(String filepath) This method restores a backup from the fileSystem

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentRestServiceV40

public DocumentRestServiceV40()

Method Detail

getRoot

@GET
 @Produces(value="application/xhtml+xml")
public javax.ws.rs.core.StreamingOutput getRoot()

getHelpHTML

@GET
 @Produces(value="text/html")
 @Path(value="/help")
public javax.ws.rs.core.StreamingOutput getHelpHTML()

getDocument

@GET
 @Path(value="/{uniqueid}")
public XMLItemCollection getDocument(@PathParam(value="uniqueid")
                                                                      String uniqueid,
                                                                      @QueryParam(value="items")
                                                                      String items)

returns a single document defined by $uniqueid

Parameters:

uniqueid -

Returns:

findDocumentsByQuery

@GET
 @Path(value="/search/{query}")
public DocumentCollection findDocumentsByQuery(@PathParam(value="query")
                                                                                    String query,
                                                                                    @DefaultValue(value="-1") @QueryParam(value="pageSize")
                                                                                    int pageSize,
                                                                                    @DefaultValue(value="0") @QueryParam(value="pageIndex")
                                                                                    int pageIndex,
                                                                                    @QueryParam(value="sortBy")
                                                                                    String sortBy,
                                                                                    @QueryParam(value="sortReverse")
                                                                                    boolean sortReverse,
                                                                                    @QueryParam(value="items")
                                                                                    String items)

Returns a resultset for a lucene Search Query

Parameters:

query -

pageSize -

pageIndex -

items -

Returns:

findDocumentsByJPQL

@GET
 @Path(value="/jpql/{query}")
public DocumentCollection findDocumentsByJPQL(@PathParam(value="query")
                                                                                 String query,
                                                                                 @DefaultValue(value="100") @QueryParam(value="pageSize")
                                                                                 int pageSize,
                                                                                 @DefaultValue(value="0") @QueryParam(value="pageIndex")
                                                                                 int pageIndex,
                                                                                 @QueryParam(value="items")
                                                                                 String items)

Returns a resultset for a JPQL statement

Parameters:

query -

pageSize -

pageIndex -

items -

Returns:

countTotalHitsByQuery

@GET
 @Path(value="/count/{query}")
public XMLCount countTotalHitsByQuery(@PathParam(value="query")
                                                                          String query,
                                                                          @DefaultValue(value="-1") @QueryParam(value="maxResult")
                                                                          int maxResult)

Returns a total hits for a lucene Search Query

Parameters:

query -

pageSize -

pageIndex -

items -

Returns:

countTotalPagesByQuery

@GET
 @Path(value="/countpages/{query}")
public XMLCount countTotalPagesByQuery(@PathParam(value="query")
                                                                                String query,
                                                                                @DefaultValue(value="-1") @QueryParam(value="pageSize")
                                                                                int pageSize)

Returns the total pages for a lucene Search Query and a given page size.

Parameters:

query -

pageSize -

pageIndex -

items -

Returns:

postEntity

@POST
 @Produces(value="application/xml")
 @Consumes(value={"application/xml","text/xml"})
public javax.ws.rs.core.Response postEntity(XMLItemCollection xmlworkitem)

The method saves a document provided in xml format. The caller need to be assigned to the access role 'org.imixs.ACCESSLEVEL.MANAGERACCESS' Note: the method merges the content of the given document into an existing one because the DocumentService method save() did not merge an entity. But the rest service typically consumes only a subset of attributes. So this is the reason why we merge the entity here. In different to the behavior of the DocumentService the WorkflowService method process() did this merge automatically.

Parameters:

xmlworkitem - - entity to be saved

Returns:

putEntity

@PUT
 @Produces(value="application/xml")
 @Consumes(value={"application/xml","text/xml"})
public javax.ws.rs.core.Response putEntity(XMLItemCollection xmlworkitem)

Delegater putEntity @PUT

Parameters:

requestBodyStream -

Returns:

See Also:

putWorkitemDefault

deleteEntity

@DELETE
 @Path(value="/{uniqueid}")
public javax.ws.rs.core.Response deleteEntity(@PathParam(value="uniqueid")
                                                                                  String uniqueid)

This method deletes an entity

backup

@PUT
 @Path(value="/backup/{query}")
public javax.ws.rs.core.Response backup(@PathParam(value="query")
                                                                             String query,
                                                                             @QueryParam(value="filepath")
                                                                             String filepath)

This method creates a backup of the result set form a JQPL query. The entity list will be stored into the file system. The backup can be restored by calling the restore method

Parameters:

query -

start -

count -

filepath - - path in server filesystem

Returns:

restore

@GET
 @Path(value="/restore")
public javax.ws.rs.core.Response restore(@QueryParam(value="filepath")
                                                                       String filepath)

This method restores a backup from the fileSystem

Parameters:

filepath - - path in server fileSystem

Returns:

getConfiguration

@GET
 @Path(value="/configuration")
 @Produces(value={"application/xml","application/json"})
public XMLItemCollection getConfiguration()
                                                                                                                                throws Exception

Returns the IndexFieldListNoAnalyse from the lucensUpdateService

Returns:

Throws:

Exception