Package se.curity.identityserver.sdk.data.query

Class ResourceQuery

Object

se.curity.identityserver.sdk.data.query.ResourceQuery

All Implemented Interfaces:

SerializableAsMap

public final class ResourceQuery
extends Object
implements SerializableAsMap

Representation of a resource query which can be used to limit selected resources.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ResourceQuery.AttributesEnumeration	A query for specific attributes.
static final class	ResourceQuery.Exclusions	Enumeration of attributes to be excluded from a query result.
static final class	ResourceQuery.Inclusions	Enumeration of attributes to be included in a query result.
static final class	ResourceQuery.Pagination	Pagination parameter of the query.
static class	ResourceQuery.Sorting	Sorting parameter of the query.

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	asMap()
static ResourceQuery	create(ResourceQuery.AttributesEnumeration attributesEnumeration, ResourceQuery.Pagination pagination, @Nullable ResourceQuery.Sorting sorting, @Nullable Filter filter)	Creates a resource query out of the provided components.
static ResourceQuery	empty()
ResourceQuery.AttributesEnumeration	getAttributesEnumeration()
@Nullable Filter	getFilter()
ResourceQuery.Pagination	getPagination()
@Nullable ResourceQuery.Sorting	getSorting()
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

empty

public static ResourceQuery empty()

Returns:

the empty resource query. This query should match all records, but may impose a limit on the number of records returned.

create

public static ResourceQuery create(ResourceQuery.AttributesEnumeration attributesEnumeration,
 ResourceQuery.Pagination pagination,
 @Nullable ResourceQuery.Sorting sorting,
 @Nullable Filter filter)

Creates a resource query out of the provided components.

Parameters:

attributesEnumeration - The ResourceQuery.AttributesEnumeration to use

pagination - The ResourceQuery.Pagination to use

sorting - What ResourceQuery.Sorting should be used (if any)

filter - What SCIM Filter should be used (if any)

Returns:

A ResourceQuery with all provided components combined

Since:

3.0.0

getAttributesEnumeration

public ResourceQuery.AttributesEnumeration getAttributesEnumeration()

Returns:

enumeration of attributes for inclusion or exclusion.

getPagination

public ResourceQuery.Pagination getPagination()

Returns:

the pagination parameters.

getSorting

@Nullable
public @Nullable ResourceQuery.Sorting getSorting()

Returns:

the query sorting parameter, if any, or null.

getFilter

@Nullable
public @Nullable Filter getFilter()

Returns:

the query filter, if any, or null.

asMap

public Map<String,Object> asMap()

Specified by:

asMap in interface SerializableAsMap

Returns:

representation of this Object as a Map containing only Java primitive types, plus instances of Collection, String and Map.

It should be possible to fully re-construct this Object from a Map obtained by calling this method.

Unfortunately, in Java it is quite hard to make the type system enforce this condition, so implementators must be especially careful about this.

Since:

2.2.0

toString

public String toString()

Overrides:

toString in class Object