net.roboconf.dm.rest.client

Class WsClient

java.lang.Object

net.roboconf.dm.rest.client.WsClient

public class WsClient
extends Object

A client for the REST API of the Deployment Manager.

This client is configured for the REST implementations that use the predefined PATH constants. Users should call destroy() to release the connection.

The following rules apply to the client implementation.

• Methods that return a list do not throw exceptions.
• Methods that return a list never return null.
• Methods that return a list only expected 2xx responses from the server.
• Methods that return an object throw an exception if they did not receive a 2xx response.
• Methods that return an object return null if they did not receive a 200 response.
• Methods that do not return anything throw an exception if they did not receive a 2xx response.

Thrown exceptions contain the error code and the error message.

About the logging policy...
Every client method logs an entry when it is invoked. It logs a second entry once the REST invocation has completed, and provided a runtime exception was not thrown by the REST library.

The second log entry either logs the response code (success), or logs the response code and the response message (error in the result).

Author:

Vincent Zurczak - Linagora

Constructor Summary

Constructors

Constructor and Description
WsClient(String rootUrl) Constructor.

Method Summary

Modifier and Type	Method and Description
void	destroy() Force the destruction of the JAX-RS client.
ApplicationWsDelegate	getApplicationDelegate()
DebugWsDelegate	getDebugDelegate()
com.sun.jersey.api.client.Client	getJerseyClient()
ManagementWsDelegate	getManagementDelegate()
PreferencesWsDelegate	getPreferencesWsDelegate()
SchedulerWsDelegate	getSchedulerDelegate()
TargetWsDelegate	getTargetWsDelegate()

Methods inherited from class java.lang.Object

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

Constructor Detail

WsClient

public WsClient(String rootUrl)

Constructor.

Parameters:

rootUrl - the root URL (example: http://192.168.1.18:9007/dm/)

Method Detail

destroy

public void destroy()

Force the destruction of the JAX-RS client.

getApplicationDelegate

public ApplicationWsDelegate getApplicationDelegate()

Returns:

the applicationDelegate

getManagementDelegate

public ManagementWsDelegate getManagementDelegate()

Returns:

the appManagementDelegate

getDebugDelegate

public DebugWsDelegate getDebugDelegate()

Returns:

the debugDelegate

getTargetWsDelegate

public TargetWsDelegate getTargetWsDelegate()

Returns:

the targetWsDelegate

getSchedulerDelegate

public SchedulerWsDelegate getSchedulerDelegate()

Returns:

the schedulerDelegate

getPreferencesWsDelegate

public PreferencesWsDelegate getPreferencesWsDelegate()

Returns:

the preferencesWsDelegate

getJerseyClient

public com.sun.jersey.api.client.Client getJerseyClient()

Returns:

the Jersey client (useful to configure it)