org.imixs.melman

Class AbstractClient

java.lang.Object

org.imixs.melman.AbstractClient

Direct Known Subclasses:

DocumentClient, EventLogClient, ModelClient

public abstract class AbstractClient
extends Object

This AbstractClient provides core functionallity of a JAX Rest Client and the feature to register authentication filters.

Author:

Ralph Soika

Field Summary

Fields

Modifier and Type	Field and Description
protected String	baseURI
protected List<javax.ws.rs.client.ClientRequestFilter>	requestFilterList

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
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.
javax.ws.rs.client.WebTarget	getWebTarget(String uri) Returns a WebTarget object for a given uri.
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.
void	setBaseURI(String baseURI)

Methods inherited from class java.lang.Object

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

Field Detail

baseURI

protected String baseURI

requestFilterList

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

Constructor Detail

AbstractClient

public AbstractClient(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)

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

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

getWebTarget

public javax.ws.rs.client.WebTarget getWebTarget(String uri)
                                          throws RestAPIException

Returns a WebTarget object for a given uri.

Parameters:

uri -

Returns:

WebTarget

Throws:

RestAPIException