| | |
| | | * (the "License"). You may not use this file except in compliance |
| | | * with the License. |
| | | * |
| | | * You can obtain a copy of the license at |
| | | * trunk/opendj3/legal-notices/CDDLv1_0.txt |
| | | * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt |
| | | * or http://forgerock.org/license/CDDLv1.0.html. |
| | | * See the License for the specific language governing permissions |
| | | * and limitations under the License. |
| | | * |
| | | * When distributing Covered Code, include this CDDL HEADER in each |
| | | * file and include the License file at |
| | | * trunk/opendj3/legal-notices/CDDLv1_0.txt. If applicable, |
| | | * add the following below this CDDL HEADER, with the fields enclosed |
| | | * by brackets "[]" replaced with your own identifying information: |
| | | * file and include the License file at legal-notices/CDDLv1_0.txt. |
| | | * If applicable, add the following below this CDDL HEADER, with the |
| | | * fields enclosed by brackets "[]" replaced with your own identifying |
| | | * information: |
| | | * Portions Copyright [yyyy] [name of copyright owner] |
| | | * |
| | | * CDDL HEADER END |
| | |
| | | |
| | | package org.forgerock.opendj.ldap.responses; |
| | | |
| | | |
| | | |
| | | import java.util.Collection; |
| | | import java.util.List; |
| | | |
| | | import org.forgerock.opendj.ldap.*; |
| | | import org.forgerock.opendj.ldap.Attribute; |
| | | import org.forgerock.opendj.ldap.AttributeDescription; |
| | | import org.forgerock.opendj.ldap.ByteString; |
| | | import org.forgerock.opendj.ldap.DN; |
| | | import org.forgerock.opendj.ldap.DecodeException; |
| | | import org.forgerock.opendj.ldap.DecodeOptions; |
| | | import org.forgerock.opendj.ldap.Entry; |
| | | import org.forgerock.opendj.ldap.controls.Control; |
| | | import org.forgerock.opendj.ldap.controls.ControlDecoder; |
| | | |
| | | |
| | | |
| | | /** |
| | | * A Search Result Entry represents an entry found during a Search operation. |
| | | * <p> |
| | |
| | | * may happen when only attribute types are requested, access controls prevent |
| | | * the return of values, or other reasons. |
| | | */ |
| | | public interface SearchResultEntry extends Response, Entry |
| | | { |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | boolean addAttribute(Attribute attribute); |
| | | public interface SearchResultEntry extends Response, Entry { |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | boolean addAttribute(Attribute attribute); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | boolean addAttribute(Attribute attribute, Collection<ByteString> duplicateValues); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | SearchResultEntry addAttribute(String attributeDescription, Object... values); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | boolean addAttribute(Attribute attribute, |
| | | Collection<ByteString> duplicateValues); |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | SearchResultEntry addControl(Control control); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | SearchResultEntry clearAttributes(); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | boolean containsAttribute(Attribute attribute, Collection<ByteString> missingValues); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | SearchResultEntry addAttribute(String attributeDescription, Object... values); |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | boolean containsAttribute(String attributeDescription, Object... values); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | Iterable<Attribute> getAllAttributes(); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | Iterable<Attribute> getAllAttributes(AttributeDescription attributeDescription); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | SearchResultEntry addControl(Control control); |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | Iterable<Attribute> getAllAttributes(String attributeDescription); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | Attribute getAttribute(AttributeDescription attributeDescription); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | Attribute getAttribute(String attributeDescription); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | SearchResultEntry clearAttributes(); |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | int getAttributeCount(); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | <C extends Control> C getControl(ControlDecoder<C> decoder, DecodeOptions options) |
| | | throws DecodeException; |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | List<Control> getControls(); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | boolean containsAttribute(Attribute attribute, |
| | | Collection<ByteString> missingValues); |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | DN getName(); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | boolean removeAttribute(Attribute attribute, Collection<ByteString> missingValues); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | boolean removeAttribute(AttributeDescription attributeDescription); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | boolean containsAttribute(String attributeDescription, Object... values); |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | SearchResultEntry removeAttribute(String attributeDescription, Object... values); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | boolean replaceAttribute(Attribute attribute); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | SearchResultEntry replaceAttribute(String attributeDescription, Object... values); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | Iterable<Attribute> getAllAttributes(); |
| | | |
| | | |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | Iterable<Attribute> getAllAttributes(AttributeDescription attributeDescription); |
| | | |
| | | |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | Iterable<Attribute> getAllAttributes(String attributeDescription); |
| | | |
| | | |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | Attribute getAttribute(AttributeDescription attributeDescription); |
| | | |
| | | |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | Attribute getAttribute(String attributeDescription); |
| | | |
| | | |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | int getAttributeCount(); |
| | | |
| | | |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | <C extends Control> C getControl(ControlDecoder<C> decoder, |
| | | DecodeOptions options) throws DecodeException; |
| | | |
| | | |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | List<Control> getControls(); |
| | | |
| | | |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | DN getName(); |
| | | |
| | | |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | boolean removeAttribute(Attribute attribute, |
| | | Collection<ByteString> missingValues); |
| | | |
| | | |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | boolean removeAttribute(AttributeDescription attributeDescription); |
| | | |
| | | |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | SearchResultEntry removeAttribute(String attributeDescription, |
| | | Object... values); |
| | | |
| | | |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | boolean replaceAttribute(Attribute attribute); |
| | | |
| | | |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | SearchResultEntry replaceAttribute(String attributeDescription, |
| | | Object... values); |
| | | |
| | | |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | SearchResultEntry setName(DN dn); |
| | | |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | SearchResultEntry setName(DN dn); |
| | | |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | SearchResultEntry setName(String dn); |
| | | /** |
| | | * {@inheritDoc} |
| | | */ |
| | | SearchResultEntry setName(String dn); |
| | | |
| | | } |