org.sonar.api.server.ws

Class WebService.NewAction

java.lang.Object

org.sonar.api.server.ws.WebService.NewAction

Enclosing interface:

WebService

public static class WebService.NewAction
extends Object

Method Summary

Modifier and Type	Method and Description
WebService.NewAction	addFieldsParam(Collection<?> possibleValues) Creates the parameter WebService.Param.FIELDS, which is used to restrict the number of fields returned in JSON response.
WebService.NewAction	addPageParam()
WebService.NewAction	addPageSize(int defaultPageSize, int maxPageSize)
WebService.NewAction	addPagingParams(int defaultPageSize) Add predefined parameters related to pagination of results.
WebService.NewAction	addPagingParams(int defaultPageSize, int maxPageSize) Add predefined parameters related to pagination of results with a maximum page size.
WebService.NewAction	addSearchQuery(String exampleValue, String... pluralFields) Creates the parameter WebService.Param.TEXT_QUERY, which is used to search for a subset of fields containing the supplied string.
WebService.NewAction	addSelectionModeParam() Add 'selected=(selected|deselected|all)' for select-list oriented WS.
<V> WebService.NewAction	addSortParams(Collection<V> possibleValues, V defaultValue, boolean defaultAscending) Add predefined parameters related to sorting of results.
WebService.NewParam	createFieldsParam(Collection<?> possibleValues)
WebService.NewParam	createParam(String paramKey)
WebService.NewAction	createParam(String paramKey, String description) Deprecated. since 4.4. Use createParam(String paramKey) instead.
<V> WebService.NewParam	createSortParams(Collection<V> possibleValues, V defaultValue, boolean defaultAscending) Add predefined parameters related to sorting of results.
WebService.NewAction	setDeprecatedKey(String s)
WebService.NewAction	setDeprecatedSince(String deprecatedSince)
WebService.NewAction	setDescription(String description) Used in Orchestrator
WebService.NewAction	setDescription(String description, Object... descriptionArgument)
WebService.NewAction	setHandler(RequestHandler h)
WebService.NewAction	setInternal(boolean b)
WebService.NewAction	setPost(boolean b)
WebService.NewAction	setResponseExample(URL url) Link to the document containing an example of response.
WebService.NewAction	setSince(String s)

Methods inherited from class java.lang.Object

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

Method Detail

setDeprecatedKey

public WebService.NewAction setDeprecatedKey(@Nullable
                                             String s)

setDescription

public WebService.NewAction setDescription(@Nullable
                                           String description)

Used in Orchestrator

setDescription

public WebService.NewAction setDescription(@Nullable
                                           String description,
                                           Object... descriptionArgument)

Since:

5.6

setSince

public WebService.NewAction setSince(@Nullable
                                     String s)

setDeprecatedSince

public WebService.NewAction setDeprecatedSince(@Nullable
                                               String deprecatedSince)

Since:

5.3

setPost

public WebService.NewAction setPost(boolean b)

setInternal

public WebService.NewAction setInternal(boolean b)

setHandler

public WebService.NewAction setHandler(RequestHandler h)

setResponseExample

public WebService.NewAction setResponseExample(@Nullable
                                               URL url)

Link to the document containing an example of response. Content must be UTF-8 encoded.
Example:

   newAction.setResponseExample(getClass().getResource("/org/sonar/my-ws-response-example.json"));
 

Since:

4.4

createParam

public WebService.NewParam createParam(String paramKey)

createParam

@Deprecated
public WebService.NewAction createParam(String paramKey,
                                                    @Nullable
                                                    String description)

Deprecated. since 4.4. Use createParam(String paramKey) instead.

addPagingParams

public WebService.NewAction addPagingParams(int defaultPageSize)

Add predefined parameters related to pagination of results.

addPagingParams

public WebService.NewAction addPagingParams(int defaultPageSize,
                                            int maxPageSize)

Add predefined parameters related to pagination of results with a maximum page size. Note the maximum is a documentation only feature. It does not check anything.

addPageParam

public WebService.NewAction addPageParam()

addPageSize

public WebService.NewAction addPageSize(int defaultPageSize,
                                        int maxPageSize)

addFieldsParam

public WebService.NewAction addFieldsParam(Collection<?> possibleValues)

Creates the parameter WebService.Param.FIELDS, which is used to restrict the number of fields returned in JSON response.

createFieldsParam

public WebService.NewParam createFieldsParam(Collection<?> possibleValues)

addSearchQuery

public WebService.NewAction addSearchQuery(String exampleValue,
                                           String... pluralFields)

Creates the parameter WebService.Param.TEXT_QUERY, which is used to search for a subset of fields containing the supplied string.

The fields must be in the plural form (ex: "names", "keys").

addSortParams

public <V> WebService.NewAction addSortParams(Collection<V> possibleValues,
                                              @Nullable
                                              V defaultValue,
                                              boolean defaultAscending)

Add predefined parameters related to sorting of results.

createSortParams

public <V> WebService.NewParam createSortParams(Collection<V> possibleValues,
                                                @Nullable
                                                V defaultValue,
                                                boolean defaultAscending)

Add predefined parameters related to sorting of results.

addSelectionModeParam

public WebService.NewAction addSelectionModeParam()

Add 'selected=(selected|deselected|all)' for select-list oriented WS.