Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright 2007-2024 Ping Identity Corporation
* All Rights Reserved.
*/
/*
* Copyright 2007-2024 Ping Identity Corporation
*
* Licensed under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/*
* Copyright (C) 2007-2024 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.sdk;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Iterator;
import com.unboundid.asn1.ASN1StreamReader;
import com.unboundid.asn1.ASN1StreamReaderSequence;
import com.unboundid.ldap.protocol.LDAPResponse;
import com.unboundid.ldap.sdk.schema.Schema;
import com.unboundid.util.Debug;
import com.unboundid.util.NotMutable;
import com.unboundid.util.NotNull;
import com.unboundid.util.Nullable;
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.sdk.LDAPMessages.*;
/**
* This class provides a data structure for representing an LDAP search result
* entry. This is a {@link ReadOnlyEntry} object that may also include zero
* or more controls included with the entry returned from the server.
*/
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class SearchResultEntry
extends ReadOnlyEntry
implements LDAPResponse
{
/**
* The serial version UID for this serializable class.
*/
private static final long serialVersionUID = -290721544252526163L;
// The set of controls returned with this search result entry.
@NotNull private final Control[] controls;
// The message ID for the LDAP message containing this response.
private final int messageID;
/**
* Creates a new search result entry with the provided information.
*
* @param dn The DN for this search result entry. It must not be
* {@code null}.
* @param attributes The set of attributes to include in this search result
* entry. It must not be {@code null}.
* @param controls The set of controls for this search result entry. It
* must not be {@code null}.
*/
public SearchResultEntry(@NotNull final String dn,
@NotNull final Attribute[] attributes,
@NotNull final Control... controls)
{
this(-1, dn, null, attributes, controls);
}
/**
* Creates a new search result entry with the provided information.
*
* @param messageID The message ID for the LDAP message containing this
* response.
* @param dn The DN for this search result entry. It must not be
* {@code null}.
* @param attributes The set of attributes to include in this search result
* entry. It must not be {@code null}.
* @param controls The set of controls for this search result entry. It
* must not be {@code null}.
*/
public SearchResultEntry(final int messageID, @NotNull final String dn,
@NotNull final Attribute[] attributes,
@NotNull final Control... controls)
{
this(messageID, dn, null, attributes, controls);
}
/**
* Creates a new search result entry with the provided information.
*
* @param messageID The message ID for the LDAP message containing this
* response.
* @param dn The DN for this search result entry. It must not be
* {@code null}.
* @param schema The schema to use for operations involving this entry.
* It may be {@code null} if no schema is available.
* @param attributes The set of attributes to include in this search result
* entry. It must not be {@code null}.
* @param controls The set of controls for this search result entry. It
* must not be {@code null}.
*/
public SearchResultEntry(final int messageID, @NotNull final String dn,
@Nullable final Schema schema,
@NotNull final Attribute[] attributes,
@NotNull final Control... controls)
{
super(dn, schema, attributes);
Validator.ensureNotNull(controls);
this.messageID = messageID;
this.controls = controls;
}
/**
* Creates a new search result entry with the provided information.
*
* @param dn The DN for this search result entry. It must not be
* {@code null}.
* @param attributes The set of attributes to include in this search result
* entry. It must not be {@code null}.
* @param controls The set of controls for this search result entry. It
* must not be {@code null}.
*/
public SearchResultEntry(@NotNull final String dn,
@NotNull final Collection attributes,
@NotNull final Control... controls)
{
this(-1, dn, null, attributes, controls);
}
/**
* Creates a new search result entry with the provided information.
*
* @param messageID The message ID for the LDAP message containing this
* response.
* @param dn The DN for this search result entry. It must not be
* {@code null}.
* @param attributes The set of attributes to include in this search result
* entry. It must not be {@code null}.
* @param controls The set of controls for this search result entry. It
* must not be {@code null}.
*/
public SearchResultEntry(final int messageID, @NotNull final String dn,
@NotNull final Collection attributes,
@NotNull final Control... controls)
{
this(messageID, dn, null, attributes, controls);
}
/**
* Creates a new search result entry with the provided information.
*
* @param messageID The message ID for the LDAP message containing this
* response.
* @param dn The DN for this search result entry. It must not be
* {@code null}.
* @param schema The schema to use for operations involving this entry.
* It may be {@code null} if no schema is available.
* @param attributes The set of attributes to include in this search result
* entry. It must not be {@code null}.
* @param controls The set of controls for this search result entry. It
* must not be {@code null}.
*/
public SearchResultEntry(final int messageID, @NotNull final String dn,
@Nullable final Schema schema,
@NotNull final Collection attributes,
@NotNull final Control... controls)
{
super(dn, schema, attributes);
Validator.ensureNotNull(controls);
this.messageID = messageID;
this.controls = controls;
}
/**
* Creates a new search result entry from the provided entry.
*
* @param entry The entry to use to create this search result entry. It
* must not be {@code null}.
* @param controls The set of controls for this search result entry. It
* must not be {@code null}.
*/
public SearchResultEntry(@NotNull final Entry entry,
@NotNull final Control... controls)
{
this(-1, entry, controls);
}
/**
* Creates a new search result entry from the provided entry.
*
* @param messageID The message ID for the LDAP message containing this
* response.
* @param entry The entry to use to create this search result entry. It
* must not be {@code null}.
* @param controls The set of controls for this search result entry. It
* must not be {@code null}.
*/
public SearchResultEntry(final int messageID, @NotNull final Entry entry,
@NotNull final Control... controls)
{
super(entry);
Validator.ensureNotNull(controls);
this.messageID = messageID;
this.controls = controls;
}
/**
* Creates a new search result entry object with the protocol op and controls
* read from the given ASN.1 stream reader.
*
* @param messageID The message ID for the LDAP message containing
* this response.
* @param messageSequence The ASN.1 stream reader sequence used in the
* course of reading the LDAP message elements.
* @param reader The ASN.1 stream reader from which to read the
* protocol op and controls.
* @param schema The schema to use to select the appropriate
* matching rule to use for each attribute. It may
* be {@code null} if the default matching rule
* should always be used.
*
* @return The decoded search result entry object.
*
* @throws LDAPException If a problem occurs while reading or decoding data
* from the ASN.1 stream reader.
*/
@NotNull()
static SearchResultEntry readSearchEntryFrom(final int messageID,
@NotNull final ASN1StreamReaderSequence messageSequence,
@NotNull final ASN1StreamReader reader,
@Nullable final Schema schema)
throws LDAPException
{
try
{
reader.beginSequence();
final String dn = reader.readString();
final ArrayList attrList = new ArrayList<>(10);
final ASN1StreamReaderSequence attrSequence = reader.beginSequence();
while (attrSequence.hasMoreElements())
{
attrList.add(Attribute.readFrom(reader, schema));
}
Control[] controls = NO_CONTROLS;
if (messageSequence.hasMoreElements())
{
final ArrayList controlList = new ArrayList<>(5);
final ASN1StreamReaderSequence controlSequence = reader.beginSequence();
while (controlSequence.hasMoreElements())
{
controlList.add(Control.readFrom(reader));
}
controls = new Control[controlList.size()];
controlList.toArray(controls);
}
return new SearchResultEntry(messageID, dn, schema, attrList, controls);
}
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);
}
}
/**
* {@inheritDoc}
*/
@Override()
public int getMessageID()
{
return messageID;
}
/**
* Retrieves the set of controls returned with this search result entry.
* Individual response controls of a specific type may be retrieved and
* decoded using the {@code get} method in the response control class.
*
* @return The set of controls returned with this search result entry.
*/
@NotNull()
public Control[] getControls()
{
return controls;
}
/**
* Retrieves the control with the specified OID. If there is more than one
* control with the given OID, then the first will be returned.
*
* @param oid The OID of the control to retrieve.
*
* @return The control with the requested OID, or {@code null} if there is no
* such control for this search result entry.
*/
@Nullable()
public Control getControl(@NotNull final String oid)
{
for (final Control c : controls)
{
if (c.getOID().equals(oid))
{
return c;
}
}
return null;
}
/**
* Generates a hash code for this entry.
*
* @return The generated hash code for this entry.
*/
@Override()
public int hashCode()
{
// We need this method to satisfy checkstyle.
return super.hashCode();
}
/**
* Indicates whether the provided object is equal to this entry. The provided
* object will only be considered equal to this entry if it is an entry with
* the same DN and set of attributes.
*
* @param o The object for which to make the determination.
*
* @return {@code true} if the provided object is considered equal to this
* entry, or {@code false} if not.
*/
@Override()
public boolean equals(@Nullable final Object o)
{
if (! super.equals(o))
{
return false;
}
if (! (o instanceof SearchResultEntry))
{
// When comparing a SearchResultEntry with an entry that isn't a
// SearchResultEntry, we'll only rely on the base entry comparison.
return true;
}
final SearchResultEntry e = (SearchResultEntry) o;
if (controls.length != e.controls.length)
{
return false;
}
for (int i=0; i < controls.length; i++)
{
if (! controls[i].equals(e.controls[i]))
{
return false;
}
}
return true;
}
/**
* Appends a string representation of this entry to the provided buffer.
*
* @param buffer The buffer to which to append the string representation of
* this entry.
*/
@Override()
public void toString(@NotNull final StringBuilder buffer)
{
buffer.append("SearchResultEntry(dn='");
buffer.append(getDN());
buffer.append('\'');
if (messageID >= 0)
{
buffer.append(", messageID=");
buffer.append(messageID);
}
buffer.append(", attributes={");
final Iterator iterator = getAttributes().iterator();
while (iterator.hasNext())
{
iterator.next().toString(buffer);
if (iterator.hasNext())
{
buffer.append(", ");
}
}
buffer.append("}, controls={");
for (int i=0; i < controls.length; i++)
{
if (i > 0)
{
buffer.append(", ");
}
controls[i].toString(buffer);
}
buffer.append("})");
}
}
