com.unboundid.scim2.server.utils

Class SimpleSearchResults<T extends com.unboundid.scim2.common.ScimResource>

java.lang.Object

com.unboundid.scim2.server.ListResponseStreamingOutput<T>

com.unboundid.scim2.server.utils.SimpleSearchResults<T>

All Implemented Interfaces:

javax.ws.rs.core.StreamingOutput

public class SimpleSearchResults<T extends com.unboundid.scim2.common.ScimResource>
extends ListResponseStreamingOutput<T>

A utility ListResponseStreamingOutput that will filter, sort, and paginate the search results for simple search implementations that always returns the entire result set.

Constructor Summary

Constructors

Constructor and Description
SimpleSearchResults(ResourceTypeDefinition resourceType, javax.ws.rs.core.UriInfo uriInfo) Create a new SimpleSearchResults for results from a search operation.

Method Summary

Methods

Modifier and Type	Method and Description
SimpleSearchResults	add(T resource) Add a resource to include in the search results.
SimpleSearchResults	addAll(Collection<T> resources) Add resources to include in the search results.
void	write(ListResponseWriter<T> os) Start streaming the contents of the list response.

Methods inherited from class com.unboundid.scim2.server.ListResponseStreamingOutput

write

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleSearchResults

public SimpleSearchResults(ResourceTypeDefinition resourceType,
                   javax.ws.rs.core.UriInfo uriInfo)
                    throws com.unboundid.scim2.common.exceptions.BadRequestException

Create a new SimpleSearchResults for results from a search operation.

Parameters:

resourceType - The resource type definition of result resources.

uriInfo - The UriInfo from the search operation.

Throws:

com.unboundid.scim2.common.exceptions.BadRequestException - if the filter or paths in the search operation is invalid.

Method Detail

add

public SimpleSearchResults add(T resource)
                        throws com.unboundid.scim2.common.exceptions.ScimException

Add a resource to include in the search results.

Parameters:

resource - The resource to add.

Returns:

this object.

Throws:

com.unboundid.scim2.common.exceptions.ScimException - If an error occurs during filtering or setting the meta attributes.

addAll

public SimpleSearchResults addAll(Collection<T> resources)
                           throws com.unboundid.scim2.common.exceptions.ScimException

Add resources to include in the search results.

Parameters:

resources - The resources to add.

Returns:

this object.

Throws:

com.unboundid.scim2.common.exceptions.ScimException - If an error occurs during filtering or setting the meta attributes.

write

public void write(ListResponseWriter<T> os)
           throws IOException

Start streaming the contents of the list response. The list response will be considered complete upon return;

Specified by:

write in class ListResponseStreamingOutput<T extends com.unboundid.scim2.common.ScimResource>

Parameters:

os - The list response output stream used to stream back elements of the list response.

Throws:

IOException - if an error occurs while writing.