Package org.nuxeo.scim.v2.api

Class ScimV2QueryContext

java.lang.Object
org.nuxeo.scim.v2.api.ScimV2QueryContext
public class ScimV2QueryContext extends Object
Since:
2023.15

  • Field Details

    • FETCH_GROUP_MEMBERS_CTX_PARAM

      public static final String FETCH_GROUP_MEMBERS_CTX_PARAM
      See Also:

    • LIMIT_QUERY_COUNT

      public static final int LIMIT_QUERY_COUNT
      See Also:

    • DEFAULT_QUERY_COUNT

      protected static final int DEFAULT_QUERY_COUNT
      See Also:

    • baseURL

      protected String baseURL

    • contexParams

      protected Map<String,Serializable> contexParams

    • count

      protected Integer count

    • descending

      protected boolean descending

    • filterString

      protected String filterString

    • sortBy

      protected String sortBy

    • startIndex

      protected Integer startIndex

    • transform

      protected UnaryOperator<com.unboundid.scim2.common.ScimResource> transform

  • Constructor Details

    • ScimV2QueryContext

      public ScimV2QueryContext()

  • Method Details

    • getBaseURL

      public String getBaseURL()

    • getContexParam

      public Serializable getContexParam(String name)

    • getContexParams

      public Map<String,Serializable> getContexParams()

    • getCount

      public Integer getCount()

    • getFilterString

      public String getFilterString()

    • getSortBy

      public String getSortBy()

    • getStartIndex

      public Integer getStartIndex()

    • getTransform

      public UnaryOperator<com.unboundid.scim2.common.ScimResource> getTransform()

    • isContextParamFalse

      public boolean isContextParamFalse(String name)

    • isContextParamTrue

      public boolean isContextParamTrue(String name)

    • isDescending

      public boolean isDescending()

    • withBaseUrl

      public ScimV2QueryContext withBaseUrl(String baseURL)
      The location base URL of the returned SCIM objects.

    • withContextParam

      public ScimV2QueryContext withContextParam(String name, Serializable value)

    • withCount

      public ScimV2QueryContext withCount(Integer count) throws com.unboundid.scim2.common.exceptions.BadRequestException
      Specifies the desired maximum number of query results per page.
      Throws:
      com.unboundid.scim2.common.exceptions.BadRequestException

    • withDescending

      public ScimV2QueryContext withDescending(boolean descending)
      If true, sorts descending, ascending otherwise.

    • withFilterString

      public ScimV2QueryContext withFilterString(String filterString)
      The SCIM filter expression (see https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2.2).

    • withSortBy

      public ScimV2QueryContext withSortBy(String sortBy)
      The attribute whose value will be used to order the returned responses.

    • withStartIndex

      public ScimV2QueryContext withStartIndex(Integer startIndex)
      The 1-based index of the first query result.

    • withTransform

      public ScimV2QueryContext withTransform(UnaryOperator<com.unboundid.scim2.common.ScimResource> transform)
      Operator to transform the resulting GroupResource into GenericScimResource.