public class LDAPControlRequestParser extends Object
Modifier and Type | Method | Description |
---|---|---|
static com.unboundid.ldap.sdk.controls.ServerSideSortRequestControl |
parseServerSideSortRequestControl(List<Object> sortParams) |
Parses a JSON array (java.util.List) representing a server-side sort
(RFC 2891) request.
|
static com.unboundid.ldap.sdk.controls.SimplePagedResultsControl |
parseSimplePagedResultsControl(Map<String,Object> pageParams) |
Parses a JSON object (java.util.Map) representing a simple paged
results (RFC 2696) request.
|
static com.unboundid.ldap.sdk.controls.VirtualListViewRequestControl |
parseVirtualListViewControl(Map<String,Object> vlvParams) |
Parses a JSON object (java.util.Map) representing a virtual list
view (draft-ietf-ldapext-ldapv3-vlv-09) request.
|
public static com.unboundid.ldap.sdk.controls.ServerSideSortRequestControl parseServerSideSortRequestControl(List<Object> sortParams) throws com.thetransactioncompany.jsonrpc2.JSONRPC2Error
Example:
[ { "key" : "sn", "reverseOrder" : false, "orderingRule" : null }, { "key" : "givenName", "reverseOrder" : false, "orderingRule" : null } ]
sortParams
- JSON array of JSON objects with properties "key"
(mandatory string), "reverseOrder" (optional
boolean, defaults to false) and "orderingRule"
(optional string, defaults to null). If
null
no control is requested.null
if none is requested.com.thetransactioncompany.jsonrpc2.JSONRPC2Error
- If the parameters are invalid.public static com.unboundid.ldap.sdk.controls.SimplePagedResultsControl parseSimplePagedResultsControl(Map<String,Object> pageParams) throws com.thetransactioncompany.jsonrpc2.JSONRPC2Error
Example:
{ "size" : 25, "cookie" : "AAAAAAAAABw=" }
pageParams
- JSON object with properties "size" (mandatory
integer, must be positive) and "cookie" (optional
BASE64 - encoded string, defaults to empty
string). If null
no control is requested.null
if none is requested.com.thetransactioncompany.jsonrpc2.JSONRPC2Error
- If the parameters are invalid.public static com.unboundid.ldap.sdk.controls.VirtualListViewRequestControl parseVirtualListViewControl(Map<String,Object> vlvParams) throws com.thetransactioncompany.jsonrpc2.JSONRPC2Error
Minimally specified example:
{ "after" : 9 }
Fully specified example:
{ "offset" : 11, "before" : 0, "after" : 9, "totalEntryCount" : 123, "cookie" : "AAAAAAAAABw=" }
vlvParams
- JSON object with properties "offset" (optional
integer, must be positive, defaults to one),
"before" (optional integer, must be zero or
positive, defaults to zero), "after" (mandatory
integer, must be zero or positive),
"totalEntryCount" (optional integer, must be zero
or positive, defaults to zero) and "cookie"
(optional BASE64 - encoded string, defaults to
empty string). If null
no control is
requested.null
if none is requested.com.thetransactioncompany.jsonrpc2.JSONRPC2Error
- If the parameters are invalid.Copyright © 2018 Connect2id. All rights reserved.