Package com.unboundid.scim2.server

Class ListResponseStreamingOutput<T extends ScimResource>

java.lang.Object

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

All Implemented Interfaces:

jakarta.ws.rs.core.StreamingOutput

Direct Known Subclasses:

SimpleSearchResults

public abstract class ListResponseStreamingOutput<T extends ScimResource>
extends Object
implements jakarta.ws.rs.core.StreamingOutput

Interface for streaming list/query results using the ListResponse container.

Constructor Summary

Constructors

Constructor	Description
ListResponseStreamingOutput()

Method Summary

Modifier and Type	Method	Description
abstract void	write(ListResponseWriter<T> os)	Start streaming the contents of the list response.
void	write(OutputStream os)

Methods inherited from class java.lang.Object

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

Constructor Detail

ListResponseStreamingOutput

public ListResponseStreamingOutput()

Method Detail

write

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

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

Parameters:

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

Throws:

IOException - if an error occurs while writing.

write

public final void write(@NotNull
                        OutputStream os)
                 throws IOException

Specified by:

write in interface jakarta.ws.rs.core.StreamingOutput

Throws:

IOException