com.hpe.adm.nga.sdk.network

Class OctaneUrl

java.lang.Object

com.hpe.adm.nga.sdk.network.OctaneUrl

public final class OctaneUrl
extends Object

Utility class for building URLs for the implementation of the OctaneHttpClient

Method Summary

Modifier and Type	Method and Description
void	addFieldsParam(String... fields) Set hte value of the "fields" param,
String	getParam(String paramName) Get the value of the query param
List<String>	getPaths() Return the current paths
boolean	hasParam(String paramName) Check whether the query param with paramName has already been set via setParam(String, String)
void	setDqlQueryParam(Query query) Set a param named "query" that is used to filter data
void	setLimitParam(int limit) Set query param named "limit", for the Octane API it controls max number of results returned from the data-set, can be used for pagination together with setOffsetParam(int)
void	setOffsetParam(int offset) Set query param named "offset", for the Octane API it controls the offset from the fist entity of the data-set, can be used for pagination together with setLimitParam(int)
void	setOrderByParam(String orderBy, boolean asc) Set the value of the "order_by" param
void	setParam(String paramName, String paramValue) Set query param
String	toString() Build the url string from the state of this object

Methods inherited from class java.lang.Object

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

Method Detail

getPaths

public List<String> getPaths()

Return the current paths

Returns:

list of strings representing the path of the current url

hasParam

public boolean hasParam(String paramName)

Check whether the query param with paramName has already been set via setParam(String, String)

Parameters:

paramName - name of the parameter

Returns:

true if the param was set, false otherwise

setParam

public void setParam(String paramName,
                     String paramValue)

Set query param

Parameters:

paramName - name of the parameter

paramValue - value of the parameter

getParam

public String getParam(String paramName)

Get the value of the query param

Parameters:

paramName - name of the parameter

Returns:

value of the parameter

addFieldsParam

public void addFieldsParam(String... fields)

Set hte value of the "fields" param,

Parameters:

fields - list of fields of the Entity to be retrieved

setLimitParam

public void setLimitParam(int limit)

Set query param named "limit", for the Octane API it controls max number of results returned from the data-set,
can be used for pagination together with setOffsetParam(int)

Parameters:

limit - value of limit

setOffsetParam

public void setOffsetParam(int offset)

Set query param named "offset", for the Octane API it controls the offset from the fist entity of the data-set,
can be used for pagination together with setLimitParam(int)

Parameters:

offset - value of offset

setOrderByParam

public void setOrderByParam(String orderBy,
                            boolean asc)

Set the value of the "order_by" param

Parameters:

orderBy - name of a field of an EntityModel, to sort by

asc - true for ascending, false for descending

setDqlQueryParam

public void setDqlQueryParam(Query query)

Set a param named "query" that is used to filter data

Parameters:

query - Query object, build by Query.QueryBuilder

toString

public String toString()

Build the url string from the state of this object

Overrides:

toString in class Object

Returns:

URL string containing base url with paths and query params