org.sonar.wsclient.services
Class AbstractQuery<M extends Model>

java.lang.Object
  org.sonar.wsclient.services.AbstractQuery<M>

Direct Known Subclasses:

CreateQuery, DeleteQuery, Query, UpdateQuery

public abstract class AbstractQuery<M extends Model>
extends Object

Since:

2.2

Field Summary

static int

DEFAULT_TIMEOUT_MILLISECONDS Default timeout for waiting data, in milliseconds.

Constructor Summary

AbstractQuery()

Method Summary

protected static void	appendUrlParameter(StringBuilder url, String paramKey, Date paramValue, boolean includeTime)
protected static void	appendUrlParameter(StringBuilder url, String paramKey, int paramValue)
protected static void	appendUrlParameter(StringBuilder url, String paramKey, Object paramValue)
protected static void	appendUrlParameter(StringBuilder url, String paramKey, Object[] paramValues)
protected static String	encode(String value) Encodes single parameter value.
String	getBody() Request body.
String	getLocale() Accepted-language, as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html
int	getTimeoutMilliseconds() Get the timeout for waiting data, in milliseconds.
abstract String	getUrl() Must start with a slash, for example: /api/metrics
AbstractQuery<M>	setLocale(String locale) Set the Accepted-language HTTP parameter
AbstractQuery<M>	setTimeoutMilliseconds(int i) Set the timeout for waiting data, in milliseconds.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_TIMEOUT_MILLISECONDS

public static final int DEFAULT_TIMEOUT_MILLISECONDS

Default timeout for waiting data, in milliseconds.

Since:

2.10

See Also:

Constant Field Values

Constructor Detail

AbstractQuery

public AbstractQuery()

Method Detail

getUrl

public abstract String getUrl()

Must start with a slash, for example: /api/metrics

IMPORTANT: In implementations of this method we must use helper methods to construct URL.

See Also:

encode(String), appendUrlParameter(StringBuilder, String, Object), appendUrlParameter(StringBuilder, String, Object[]), appendUrlParameter(StringBuilder, String, Date, boolean)

getBody

public String getBody()

Request body. By default it is empty but it can be overridden.

getTimeoutMilliseconds

public final int getTimeoutMilliseconds()

Get the timeout for waiting data, in milliseconds. A value of zero is interpreted as an infinite timeout.

Since:

2.10

setTimeoutMilliseconds

public final AbstractQuery<M> setTimeoutMilliseconds(int i)

Set the timeout for waiting data, in milliseconds. Avalue of zero is interpreted as an infinite timeout.

Since:

2.10

getLocale

public final String getLocale()

Accepted-language, as defined in http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

Since:

2.10

setLocale

public final AbstractQuery<M> setLocale(String locale)

Set the Accepted-language HTTP parameter

Since:

2.10

encode

protected static String encode(String value)

Encodes single parameter value.

appendUrlParameter

protected static void appendUrlParameter(StringBuilder url,
                                         String paramKey,
                                         int paramValue)

appendUrlParameter

protected static void appendUrlParameter(StringBuilder url,
                                         String paramKey,
                                         @Nullable
                                         Object paramValue)

appendUrlParameter

protected static void appendUrlParameter(StringBuilder url,
                                         String paramKey,
                                         @Nullable
                                         Object[] paramValues)

appendUrlParameter

protected static void appendUrlParameter(StringBuilder url,
                                         String paramKey,
                                         @Nullable
                                         Date paramValue,
                                         boolean includeTime)