eu.agilejava.snoop.client

Class SnoopServiceClient

java.lang.Object

eu.agilejava.snoop.client.SnoopServiceClient

public class SnoopServiceClient
extends Object

Client API for calling services registered with Snoop.

Author:

Ivar Grimstad (ivar.grimstad@gmail.com)

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.client.WebTarget	getServiceRoot() Locator to get the service root for the service registered with Snoop.
Optional<javax.ws.rs.core.Response>	simpleDelete(String resourcePath) Convenience method for making a simple DELETE request on a resource.
Optional<javax.ws.rs.core.Response>	simpleGet(String resourcePath) Convenience method for making a simple GET request on a resource.
Optional<javax.ws.rs.core.Response>	simplePost(String resourcePath, Object resource) Convenience method for making a simple POST request on a resource.
Optional<javax.ws.rs.core.Response>	simplePut(String resourcePath, Object resource) Convenience method for making a simple PUT request on a resource.

Methods inherited from class java.lang.Object

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

Method Detail

getServiceRoot

public javax.ws.rs.client.WebTarget getServiceRoot()
                                            throws SnoopServiceUnavailableException

Locator to get the service root for the service registered with Snoop. Use this method if the convenience methods simpleXXX are not sufficient or to avoid the extra call to Snoop for every request.

Returns:

the serviceRoot

Throws:

SnoopServiceUnavailableException - if service is not available

simpleGet

public Optional<javax.ws.rs.core.Response> simpleGet(String resourcePath)

Convenience method for making a simple GET request on a resource. Calling this method will result in a call to Snoop to retrieve the current configuration for the service in addition to the actual GET request.

Parameters:

resourcePath - The relative path to the resource

Returns:

an optional response that is empty if the service is unavailable.

simpleDelete

public Optional<javax.ws.rs.core.Response> simpleDelete(String resourcePath)

Convenience method for making a simple DELETE request on a resource. Calling this method will result in a call to Snoop to retrieve the current configuration for the service in addition to the actual DELETE request.

Parameters:

resourcePath - The relative path to the resource

Returns:

an optional response that is empty if the service is unavailable.

simplePut

public Optional<javax.ws.rs.core.Response> simplePut(String resourcePath,
                                                     Object resource)

Convenience method for making a simple PUT request on a resource. Calling this method will result in a call to Snoop to retrieve the current configuration for the service in addition to the actual PUT request.

Parameters:

resourcePath - The relative path to the resource

resource - The changes made to this resource

Returns:

an optional response that is empty if the service is unavailable.

simplePost

public Optional<javax.ws.rs.core.Response> simplePost(String resourcePath,
                                                      Object resource)

Convenience method for making a simple POST request on a resource. Calling this method will result in a call to Snoop to retrieve the current configuration for the service in addition to the actual POST request.

Parameters:

resourcePath - The relative path to the resource

resource - The new resource

Returns:

an optional response that is empty if the service is unavailable.