org.openepics.cable.client

Class CableDBClient

java.lang.Object

org.openepics.cable.client.CableDBClient

public class CableDBClient
extends Object

This is CableDB service client API that clients can use to access the service.

Author:

Miha Vitorovič

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTIES_FILENAME Name of the properties file
static String	PROPERTY_NAME_BASE_URL Name of the Base REST service URL property
static String	PROPERTY_NAME_PASSWORD Name of the password property
static String	PROPERTY_NAME_USERNAME Name of the username property

Constructor Summary

Constructors

Constructor and Description
CableDBClient(Properties userProperties) Constructs the instance of the client and loads properties from PROPERTIES_FILENAME file found on class path.

Method Summary

Modifier and Type	Method and Description
String	buildUrl(String... path) Builds a url with the base path and the path parameter specified as parameter
CableResource	createCableResource() For development purposes.
String	getBaseURL()
protected static javax.ws.rs.core.UriBuilder	getBuilder(String url, javax.ws.rs.core.MultivaluedMap<String,Object> queryParameters) This has been moved to a separate method so that it can be called from Unit Tests.
String	getPassword()
ClosableResponse	getResponse(String url) Requests JSON type data from URL.
ClosableResponse	getResponse(String url, javax.ws.rs.core.MultivaluedMap<String,Object> queryParameters) Requests JSON type data from URL.
ClosableResponse	getResponse(String url, String paramName, Object paramValue) Requests JSON type data from URL using a query string parameter.
String	getUserName()
static void	main(String[] args) For development purposes.

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY_NAME_BASE_URL

public static final String PROPERTY_NAME_BASE_URL

Name of the Base REST service URL property

See Also:

Constant Field Values

PROPERTY_NAME_USERNAME

public static final String PROPERTY_NAME_USERNAME

Name of the username property

See Also:

Constant Field Values

PROPERTY_NAME_PASSWORD

public static final String PROPERTY_NAME_PASSWORD

Name of the password property

See Also:

Constant Field Values

PROPERTIES_FILENAME

public static final String PROPERTIES_FILENAME

Name of the properties file

See Also:

Constant Field Values

Constructor Detail

CableDBClient

public CableDBClient(@Nullable
                     Properties userProperties)

Constructs the instance of the client and loads properties from PROPERTIES_FILENAME file found on class path. All values can be overridden by setting the system properties, but that has to be done before this class is loaded.

Configurable properties are PROPERTY_NAME_BASE_URL, PROPERTY_NAME_USERNAME, PROPERTY_NAME_PASSWORD

Parameters:

userProperties - optional (can be null) properties file that contains configurable properties

Method Detail

getResponse

public ClosableResponse getResponse(String url,
                                    @Nullable
                                    javax.ws.rs.core.MultivaluedMap<String,Object> queryParameters)

Requests JSON type data from URL.

Method is thread-safe.

Parameters:

url - to send request

queryParameters - optional list of query parameters to use in request

Returns:

received response

Throws:

IllegalStateException - if either the username or password not set

getBuilder

protected static javax.ws.rs.core.UriBuilder getBuilder(String url,
                                                        @Nullable
                                                        javax.ws.rs.core.MultivaluedMap<String,Object> queryParameters)

This has been moved to a separate method so that it can be called from Unit Tests.

Parameters:

url - the base service URL to use

queryParameters - a list of parameters to use for building the URL

Returns:

the UriBuilder initialized with correct values

getResponse

public ClosableResponse getResponse(String url)

Requests JSON type data from URL.

Method is thread-safe.

Parameters:

url - to send request

Returns:

received response

Throws:

IllegalStateException - if either the username or password not set

getResponse

public ClosableResponse getResponse(String url,
                                    String paramName,
                                    Object paramValue)

Requests JSON type data from URL using a query string parameter.

Method is thread-safe.

Parameters:

url - to send request to

paramName - query string parameter name to set

paramValue - query string parameter value to set

Returns:

received response

Throws:

IllegalStateException - if either the username or password are not set

IllegalArgumentException - if either paramName or paramValue are null

buildUrl

public String buildUrl(String... path)

Builds a url with the base path and the path parameter specified as parameter

Parameters:

path - the sub-path of the base url

Returns:

URL path section under the base URL

getBaseURL

public String getBaseURL()

getUserName

public String getUserName()

getPassword

public String getPassword()

createCableResource

public CableResource createCableResource()

For development purposes.

Returns:

a CableResource object

main

public static void main(String[] args)

For development purposes.

Parameters:

args - command line parameters