org.imixs.melman

Class DocumentClient

java.lang.Object

org.imixs.melman.DocumentClient

Direct Known Subclasses:

WorkflowClient

public class DocumentClient
extends Object

This ServiceClient is a WebService REST Client which encapsulate the communication with a REST web serice based on the Imixs Workflow REST API. The Implementation is based on the JAXB API 2.0.

Author:

Ralph Soika

Field Summary

Fields

Modifier and Type	Field and Description
protected String	baseURI
static int	DEFAULT_PAGE_SIZE
static String	DEFAULT_TYPE
protected String	items
protected int	pageIndex
protected int	pageSize
protected List<javax.ws.rs.client.ClientRequestFilter>	requestFilterList
protected String	sortBy
protected boolean	sortReverse
protected String	type

Constructor Summary

Constructors

Constructor and Description
DocumentClient(String base_uri) Initialize the client by a BASE_URL.

Method Summary

Modifier and Type	Method and Description
org.imixs.workflow.ItemCollection	createAdminPJob(org.imixs.workflow.ItemCollection document) Creates a new AdminPJobInstance
void	deleteDocument(String uniqueid) Deletes a single workItem or document instance by UniqueID.
String	getBaseURI()
List<org.imixs.workflow.ItemCollection>	getCustomResource(String uri) Returns the custom data list by uri GET
org.imixs.workflow.xml.XMLDataCollection	getCustomResourceXML(String uri) Returns the custom data list by uri GET as a collection of XMLDocument elements.
org.imixs.workflow.ItemCollection	getDocument(String uniqueid) Returns a single document instance by UniqueID.
String	getItems()
int	getPageIndex()
int	getPageSize()
String	getSortBy()
String	getType() retruns the document type.
boolean	isSortReverse()
javax.ws.rs.client.Client	newClient() This method creates a new javax.ws.rs.client.Client instance using the default client builder implementation class provided by the JAX-RS implementation provider.
void	registerClientRequestFilter(javax.ws.rs.client.ClientRequestFilter filter) Register a ClientRequestFilter instance.
org.imixs.workflow.ItemCollection	saveDocument(org.imixs.workflow.ItemCollection document) Creates or updates a single document instance.
List<org.imixs.workflow.ItemCollection>	searchDocuments(String query) Returns the the search result of a lucene search.
void	setBaseURI(String baseURI)
void	setItems(String items)
void	setPageIndex(int pageIndex)
void	setPageSize(int pageSize)
void	setSortBy(String sortBy)
void	setSortOrder(String sortBy, boolean sortReverse)
void	setSortReverse(boolean sortReverse)
void	setType(String type)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PAGE_SIZE

public static final int DEFAULT_PAGE_SIZE

See Also:

Constant Field Values

DEFAULT_TYPE

public static final String DEFAULT_TYPE

See Also:

Constant Field Values

baseURI

protected String baseURI

sortBy

protected String sortBy

sortReverse

protected boolean sortReverse

type

protected String type

pageSize

protected int pageSize

pageIndex

protected int pageIndex

items

protected String items

requestFilterList

protected List<javax.ws.rs.client.ClientRequestFilter> requestFilterList

Constructor Detail

DocumentClient

public DocumentClient(String base_uri)

Initialize the client by a BASE_URL.

Parameters:

base_uri -

Method Detail

registerClientRequestFilter

public void registerClientRequestFilter(javax.ws.rs.client.ClientRequestFilter filter)

Register a ClientRequestFilter instance.

Parameters:

filter - - request filter instance.

getBaseURI

public String getBaseURI()

setBaseURI

public void setBaseURI(String baseURI)

getPageSize

public int getPageSize()

setPageSize

public void setPageSize(int pageSize)

getPageIndex

public int getPageIndex()

setPageIndex

public void setPageIndex(int pageIndex)

getItems

public String getItems()

setItems

public void setItems(String items)

getType

public String getType()

retruns the document type. The default value is "workitem"

Returns:

setType

public void setType(String type)

getSortBy

public String getSortBy()

setSortBy

public void setSortBy(String sortBy)

isSortReverse

public boolean isSortReverse()

setSortReverse

public void setSortReverse(boolean sortReverse)

setSortOrder

public void setSortOrder(String sortBy,
                         boolean sortReverse)

newClient

public javax.ws.rs.client.Client newClient()

This method creates a new javax.ws.rs.client.Client instance using the default client builder implementation class provided by the JAX-RS implementation provider.

The method registers all known filter instances.

The client instance should be closed after the request if finished.

Returns:

javax.ws.rs.client.Client instance

saveDocument

public org.imixs.workflow.ItemCollection saveDocument(org.imixs.workflow.ItemCollection document)
                                               throws RestAPIException

Creates or updates a single document instance.

Parameters:

document - - a ItemCollection representing the document.

Returns:

updated document instance

Throws:

RestAPIException

createAdminPJob

public org.imixs.workflow.ItemCollection createAdminPJob(org.imixs.workflow.ItemCollection document)
                                                  throws RestAPIException

Creates a new AdminPJobInstance

Parameters:

document - - a ItemCollection representing the job.

Returns:

updated job instance

Throws:

RestAPIException

getDocument

public org.imixs.workflow.ItemCollection getDocument(String uniqueid)
                                              throws RestAPIException

Returns a single document instance by UniqueID.

Parameters:

uniqueid -

Returns:

workitem

Throws:

RestAPIException

deleteDocument

public void deleteDocument(String uniqueid)
                    throws RestAPIException

Deletes a single workItem or document instance by UniqueID.

Parameters:

userid -

Throws:

RestAPIException

searchDocuments

public List<org.imixs.workflow.ItemCollection> searchDocuments(String query)
                                                        throws RestAPIException,
                                                               UnsupportedEncodingException

Returns the the search result of a lucene search.

The method creates a search URL and requests a CustomResource by GET. The lucene query is encoded by this method. The method throws a UnsupportedEncodingException if the query string can not be encoded.

Parameters:

query - - lucene search query

Returns:

result list

Throws:

RestAPIException

UnsupportedEncodingException

getCustomResource

public List<org.imixs.workflow.ItemCollection> getCustomResource(String uri)
                                                          throws RestAPIException

Returns the custom data list by uri GET

Parameters:

userid -

items -

Returns:

result list

Throws:

RestAPIException

getCustomResourceXML

public org.imixs.workflow.xml.XMLDataCollection getCustomResourceXML(String uri)
                                                              throws RestAPIException

Returns the custom data list by uri GET as a collection of XMLDocument elements.

Parameters:

userid -

items -

Returns:

result list of XMLDocument elements

Throws:

RestAPIException