1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1999
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
package com.netscape.jndi.ldap.controls;
import javax.naming.NamingException;
import javax.naming.ldap.Control;
import netscape.ldap.LDAPControl;
import netscape.ldap.LDAPException;
import netscape.ldap.controls.*;
import com.netscape.jndi.ldap.common.ExceptionMapper;
/**
* The LDAP server sends back a sort response control to indicate
* the result of the sorting operation. (The OID for this control
* is 1.2.840.113556.1.4.474.)
* <P>
*
* This control contains:
* <P>
*
* <UL>
* <LI>the result code from the sorting operation
* <LI>optionally, the first attribute type in the sort key list
* that resulted in an error (for example, if the attribute does
* not exist)
* </UL>
* <P>
*
* To parse this control, use the <CODE>parseResponse</CODE> method.
* <P>
*
* The following table lists what kinds of results to expect from the
* LDAP server under different situations:
* <P>
*
* <TABLE BORDER=1 COLS=4>
* <TR VALIGN=BASELINE>
* <TH>Does the Server Support the Sorting Control?</TH>
* <TH>Is the Sorting Control Marked As Critical?</TH>
* <TH>Other Conditions</TH>
* <TH>Results from LDAP Server</TH>
* </TR>
* <TR VALIGN=BASELINE>
* <TD ROWSPAN=2>
* No
* </TD>
* <TD>
* Yes
* </TD>
* <TD>
* None
* </TD>
* <TD>
* <UL>
* <LI>The server does not send back any entries.
* <LI>An LDAPException.UNAVAILABLE_CRITICAL_EXTENSION
* exception is thrown.
* </UL>
* </TD>
* </TR>
* <TR VALIGN=BASELINE>
* <TD>
* No
* </TD>
* <TD>
* None
* </TD>
* <TD>
* <UL>
* <LI>The server ignores the sorting control and
* returns the entries unsorted.
* </UL>
* <P>
* </TD>
* </TR>
* <TR VALIGN=BASELINE>
* <TD ROWSPAN=4>
* Yes
* </TD>
* <TD>
* Yes
* </TD>
* <TD ROWSPAN=2>
* The server cannot sort the results using the specified
* sort key list.
* </TD>
* <TD>
* <UL>
* <LI>The server does not send back any entries.
* <LI>An LDAPException.UNAVAILABLE_CRITICAL_EXTENSION
* exception is thrown.
* <LI>The server sends back the sorting response control, which
* specifies the result code of the sort attempt and (optionally)
* the attribute type that caused the error.
* </UL>
* </TD>
* </TR>
* <TR VALIGN=BASELINE>
* <TD>
* No
* </TD>
* <TD>
* <UL>
* <LI>The server returns the entries unsorted.
* <LI>The server sends back the sorting response control, which
* specifies the result code of the sort attempt and (optionally)
* the attribute type that caused the error.
* </UL>
* </TD>
* </TR>
* <TR VALIGN=BASELINE>
* <TD ROWSPAN=2>
* N/A (could either be marked as critical or not)
* </TD>
* <TD>
* The server successfully sorted the entries.
* </TD>
* <TD>
* <UL>
* <LI>The server sends back the sorted entries.
* <LI>The server sends back the sorting response control, which
* specifies the result code of the sort attempt
* (LDAPException.SUCCESS).
* </UL>
* </TD>
* </TR>
* <TR VALIGN=BASELINE>
* <TD>
* The search itself failed (for any reason).
* </TD>
* <TD>
* <UL>
* <LI>The server sends back a result code for the search
* operation.
* <LI>The server does not send back the sorting response control.
* </UL>
* </TD>
* </TR>
* </TABLE>
* <P>
* @see com.netscape.jndi.ldap.controls.LdapSortKey
* @see com.netscape.jndi.ldap.controls.LdapSortControl
*/
public class LdapSortResponseControl extends LDAPSortControl implements Control {
/**
* Constructs a new <CODE>LdapEntryChangeControl</CODE> object.
* This constructor is used by the NetscapeControlFactory
*
*/
LdapSortResponseControl(boolean critical, byte[] value) throws Exception{
super(SORTRESPONSE, critical, value);
}
/**
* Get the first attribute type from the sort key list that
* resulted in an error
* @return Attribute name that resulted in an error
*/
public String getFailedAttribute() {
return super.getFailedAttribute();
}
/**
* Return the sort result code
* @return The sort result code
*/
public int getResultCode() {
return super.getResultCode();
}
/**
* Return corresponding NamingException for the sort error code
* @return NamingException for the sort error code
*/
public NamingException getSortException() {
if (getResultCode() == 0) { // success
return null;
}
return ExceptionMapper.getNamingException(
new LDAPException("Server Sort Failed", getResultCode()));
}
/**
* Retrieves the ASN.1 BER encoded value of the LDAP control.
* Null is returned if the value is absent.
* @return A possibly null byte array representing the ASN.1 BER
* encoded value of the LDAP control.
*/
public byte[] getEncodedValue() {
return getValue();
}
}
|
