File: JDAPSearchResponse.java

package info (click to toggle)
ldapjdk 4.20.0%2Bdfsg1-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 9,708 kB
  • sloc: ansic: 44,727; java: 39,132; xml: 7,419; sh: 4,185; perl: 3,774; makefile: 1,681; cpp: 979
file content (159 lines) | stat: -rw-r--r-- 4,899 bytes parent folder | download | duplicates (9)
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
/* -*- 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 org.ietf.ldap.client.opers;

import java.util.*;
import org.ietf.ldap.*;
import org.ietf.ldap.client.*;
import org.ietf.ldap.ber.stream.*;
import java.io.*;
import java.net.*;

/**
 * This class implements the search response. This object
 * is sent from the ldap server to the interface.
 * <pre>
 * entry [APPLICATION 4] SEQUENCE {
 *   objectName LDAPDN,
 *   attributes SEQUENCE OF SEQUENCE {
 *     AttributeType,
 *     SET OF AttributeValue
 *   }
 * }
 * </pre>
 *
 * Note that the following is the LDAPv3 definition:
 * <pre>
 * SearchResultEntry ::= [APPLICATION 4] SEQUENCE {
 *   objectName LDAPDN,
 *   attributes PartialAttributeList
 * }
 * PartialAttributeList ::= SEQUENCE OF SEQUENCE {
 *   type AttributeDescription,
 *   vals SET OF AttributeValue
 * }
 * </pre>
 *
 * @version 1.0
 */
public class JDAPSearchResponse implements JDAPProtocolOp {
    /**
     * Internal variables
     */
    protected String m_object_name = null;
    protected BERElement m_element = null;
    protected LDAPAttribute m_attributes[] = null;

    /**
     * Constructs search response.
     * @param element ber element of search response
     */
    public JDAPSearchResponse(BERElement element) throws IOException {
        m_element = element;

        BERTag tag = (BERTag)element;
        BERSequence seq = (BERSequence)tag.getValue();
        BEROctetString name = (BEROctetString)seq.elementAt(0);
        byte buf[] = null;
        buf = name.getValue();
        if (buf == null)
            m_object_name = null;
        else {
            try{
                m_object_name = new String(buf, "UTF8");
            } catch(Throwable x)
            {}
        }
        BERSequence attrs = (BERSequence)seq.elementAt(1);
        if (attrs.size() > 0) {
            m_attributes = new LDAPAttribute[attrs.size()];
            for (int i = 0; i < attrs.size(); i++) {
                m_attributes[i] = new LDAPAttribute(attrs.elementAt(i));
            }
        }
    }

    /**
     * Retrieves ber representation of the result.
     * @return ber representation
     */
    public BERElement getBERElement() {
        return m_element;
    }

    /**
     * Retrieves object name
     * @return object name
     */
    public String getObjectName() {
        return m_object_name;
    }

    /**
     * Retrieves attributes
     * @return attributes
     */
    public LDAPAttribute[] getAttributes() {
        return m_attributes;
    }

    /**
     * Retrieves the protocol operation type.
     * @return protocol type
     */
    public int getType() {
        return JDAPProtocolOp.SEARCH_RESPONSE;
    }

    /**
     * Retrieve the string representation.
     * @return string representation
     */
    public String toString() {
        String s = "";
        if (m_attributes != null) {
            for (int i = 0; i < m_attributes.length; i++) {
                if (i != 0)
                    s = s + ",";
                s = s + m_attributes[i].toString();
            }
        }
        return "SearchResponse {entry='" + m_object_name + "', attributes='" +
          s + "'}";
    }
}