com.unboundid.ldap.protocol.SearchResultEntryProtocolOp Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of unboundid-ldapsdk Show documentation
Show all versions of unboundid-ldapsdk Show documentation
The UnboundID LDAP SDK for Java is a fast, comprehensive, and easy-to-use
Java API for communicating with LDAP directory servers and performing
related tasks like reading and writing LDIF, encoding and decoding data
using base64 and ASN.1 BER, and performing secure communication. This
package contains the Standard Edition of the LDAP SDK, which is a
complete, general-purpose library for communicating with LDAPv3 directory
servers.
/*
* Copyright 2009-2018 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright (C) 2009-2018 Ping Identity Corporation
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License (GPLv2 only)
* or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see .
*/
package com.unboundid.ldap.protocol;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import com.unboundid.asn1.ASN1Buffer;
import com.unboundid.asn1.ASN1BufferSequence;
import com.unboundid.asn1.ASN1Element;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.asn1.ASN1Sequence;
import com.unboundid.asn1.ASN1StreamReader;
import com.unboundid.asn1.ASN1StreamReaderSequence;
import com.unboundid.ldap.sdk.Attribute;
import com.unboundid.ldap.sdk.Control;
import com.unboundid.ldap.sdk.Entry;
import com.unboundid.ldap.sdk.LDAPException;
import com.unboundid.ldap.sdk.ResultCode;
import com.unboundid.ldap.sdk.SearchResultEntry;
import com.unboundid.util.Debug;
import com.unboundid.util.InternalUseOnly;
import com.unboundid.util.NotMutable;
import com.unboundid.util.StaticUtils;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import com.unboundid.util.Validator;
import static com.unboundid.ldap.protocol.ProtocolMessages.*;
/**
* This class provides an implementation of an LDAP search result entry protocol
* op.
*/
@InternalUseOnly()
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class SearchResultEntryProtocolOp
implements ProtocolOp
{
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = 6501366526364541767L;
// The list of attributes for this search result entry.
private final List attributes;
// The entry DN for this search result entry.
private final String dn;
/**
* Creates a new search result entry protocol op with the provided
* information.
*
* @param dn The entry DN for this search result entry.
* @param attributes The list of attributes to include in this search result
* entry.
*/
public SearchResultEntryProtocolOp(final String dn,
final List attributes)
{
this.dn = dn;
this.attributes = Collections.unmodifiableList(attributes);
}
/**
* Creates a new search result entry protocol op from the provided entry.
*
* @param entry The entry to use to create this protocol op.
*/
public SearchResultEntryProtocolOp(final Entry entry)
{
dn = entry.getDN();
attributes = Collections.unmodifiableList(new ArrayList<>(
entry.getAttributes()));
}
/**
* Creates a new search result entry protocol op read from the provided ASN.1
* stream reader.
*
* @param reader The ASN.1 stream reader from which to read the search
* result entry protocol op.
*
* @throws LDAPException If a problem occurs while reading or parsing the
* search result entry.
*/
SearchResultEntryProtocolOp(final ASN1StreamReader reader)
throws LDAPException
{
try
{
reader.beginSequence();
dn = reader.readString();
Validator.ensureNotNull(dn);
final ArrayList attrs = new ArrayList<>(10);
final ASN1StreamReaderSequence attrSequence = reader.beginSequence();
while (attrSequence.hasMoreElements())
{
attrs.add(Attribute.readFrom(reader));
}
attributes = Collections.unmodifiableList(attrs);
}
catch (final LDAPException le)
{
Debug.debugException(le);
throw le;
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_SEARCH_ENTRY_CANNOT_DECODE.get(
StaticUtils.getExceptionMessage(e)),
e);
}
}
/**
* Retrieves the DN for this search result entry.
*
* @return The DN for this search result entry.
*/
public String getDN()
{
return dn;
}
/**
* Retrieves the list of attributes for this search result entry.
*
* @return The list of attributes for this search result entry.
*/
public List getAttributes()
{
return attributes;
}
/**
* {@inheritDoc}
*/
@Override()
public byte getProtocolOpType()
{
return LDAPMessage.PROTOCOL_OP_TYPE_SEARCH_RESULT_ENTRY;
}
/**
* {@inheritDoc}
*/
@Override()
public ASN1Element encodeProtocolOp()
{
final ArrayList attrElements =
new ArrayList<>(attributes.size());
for (final Attribute a : attributes)
{
attrElements.add(a.encode());
}
return new ASN1Sequence(LDAPMessage.PROTOCOL_OP_TYPE_SEARCH_RESULT_ENTRY,
new ASN1OctetString(dn),
new ASN1Sequence(attrElements));
}
/**
* Decodes the provided ASN.1 element as a search result entry protocol op.
*
* @param element The ASN.1 element to be decoded.
*
* @return The decoded search result entry protocol op.
*
* @throws LDAPException If the provided ASN.1 element cannot be decoded as
* a search result entry protocol op.
*/
public static SearchResultEntryProtocolOp decodeProtocolOp(
final ASN1Element element)
throws LDAPException
{
try
{
final ASN1Element[] elements =
ASN1Sequence.decodeAsSequence(element).elements();
final String dn =
ASN1OctetString.decodeAsOctetString(elements[0]).stringValue();
final ASN1Element[] attrElements =
ASN1Sequence.decodeAsSequence(elements[1]).elements();
final ArrayList attributes =
new ArrayList<>(attrElements.length);
for (final ASN1Element e : attrElements)
{
attributes.add(Attribute.decode(ASN1Sequence.decodeAsSequence(e)));
}
return new SearchResultEntryProtocolOp(dn, attributes);
}
catch (final Exception e)
{
Debug.debugException(e);
throw new LDAPException(ResultCode.DECODING_ERROR,
ERR_SEARCH_ENTRY_CANNOT_DECODE.get(
StaticUtils.getExceptionMessage(e)),
e);
}
}
/**
* {@inheritDoc}
*/
@Override()
public void writeTo(final ASN1Buffer buffer)
{
final ASN1BufferSequence opSequence =
buffer.beginSequence(LDAPMessage.PROTOCOL_OP_TYPE_SEARCH_RESULT_ENTRY);
buffer.addOctetString(dn);
final ASN1BufferSequence attrSequence = buffer.beginSequence();
for (final Attribute a : attributes)
{
a.writeTo(buffer);
}
attrSequence.end();
opSequence.end();
}
/**
* Creates a search result entry from this protocol op.
*
* @param controls The set of controls to include in the search result
* entry. It may be empty or {@code null} if no controls
* should be included.
*
* @return The search result entry that was created.
*/
public SearchResultEntry toSearchResultEntry(final Control... controls)
{
return new SearchResultEntry(dn, attributes, controls);
}
/**
* Retrieves a string representation of this protocol op.
*
* @return A string representation of this protocol op.
*/
@Override()
public String toString()
{
final StringBuilder buffer = new StringBuilder();
toString(buffer);
return buffer.toString();
}
/**
* {@inheritDoc}
*/
@Override()
public void toString(final StringBuilder buffer)
{
buffer.append("SearchResultEntryProtocolOp(dn='");
buffer.append(dn);
buffer.append("', attrs={");
final Iterator iterator = attributes.iterator();
while (iterator.hasNext())
{
iterator.next().toString(buffer);
if (iterator.hasNext())
{
buffer.append(',');
}
}
buffer.append("})");
}
}