Class SortControlExchange

java.lang.Object

org.springframework.ldap.control.SortControlExchange

All Implemented Interfaces:

ControlExchange<SortControl, SortResponseControl>

public class SortControlExchange
extends Object
implements ControlExchange<SortControl, SortResponseControl>

A ControlExchange implementation for managing LDAP server-side sort request and response controls.

This class pairs a SortControl request with its corresponding SortResponseControl response. The sort control requests that search results be sorted by the server, and the response control indicates whether the sort was successful and provides result codes if there were errors.

Instances of this class are immutable. The withResponse(SortResponseControl) method returns a new instance with the updated response control.

Since:

4.1

See Also:

• SortControl
• SortResponseControl
• ControlExchange
• RFC 2891 - LDAP Control Extension for Server Side Sorting of Search Results

Constructor Summary

Constructors

Constructor	Description
SortControlExchange(String... sortBy)	Constructs a new sort control exchange with the specified attributes to sort by

Method Summary

Modifier and Type	Method	Description
SortControl	getRequest()	Returns the request control.
@Nullable SortResponseControl	getResponse()	Returns the response control, if one has been received.
SortControlExchange	withResponse(SortResponseControl response)	Creates a new exchange with the specified response control.

Methods inherited from class Object

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

Constructor Details

SortControlExchange

public SortControlExchange(String... sortBy)

Constructs a new sort control exchange with the specified attributes to sort by

Parameters:

sortBy - the attributes to sort by

Method Details

getRequest

public SortControl getRequest()

Returns the request control.

Specified by:

getRequest in interface ControlExchange<SortControl, SortResponseControl>

Returns:

the request control

getResponse

public @Nullable SortResponseControl getResponse()

Returns the response control, if one has been received.

Specified by:

getResponse in interface ControlExchange<SortControl, SortResponseControl>

Returns:

the response control, or null if no response has been received

withResponse

public SortControlExchange withResponse(SortResponseControl response)

Creates a new exchange with the specified response control.

If the provided control is not a SortResponseControl, this method returns the current exchange unchanged.

Specified by:

withResponse in interface ControlExchange<SortControl, SortResponseControl>

Parameters:

response - the response control to add to the exchange

Returns:

a new SortControlExchange with the response, or this exchange if the response is not a SortResponseControl