org.ldaptive.SearchResultReference Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ldaptive Show documentation
Java LDAP API
There is a newer version: 2.4.1
/* See LICENSE for licensing and NOTICE for copyright. */
package org.ldaptive;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import org.ldaptive.asn1.AbstractParseHandler;
import org.ldaptive.asn1.DERBuffer;
import org.ldaptive.asn1.DERParser;
import org.ldaptive.asn1.DERPath;
import org.ldaptive.asn1.OctetStringType;

/**
 * LDAP search result entry defined as:
 *
 *    SearchResultReference ::= [APPLICATION 19] SEQUENCE
     SIZE (1..MAX) OF uri URI
 * 
 *
 * @author  Middleware Services
 */
public final class SearchResultReference extends AbstractMessage implements Freezable
{

  /** BER protocol number. */
  public static final int PROTOCOL_OP = 19;

  /** hash code seed. */
  private static final int HASH_CODE_SEED = 10313;

  /** DER path to referral URI. */
  private static final DERPath REFERRAL_URI_PATH = new DERPath("/SEQ/APP(19)/OCTSTR");

  /** List of references. */
  private final List references = new ArrayList<>();

  /** Whether this object has been marked immutable. */
  private volatile boolean immutable;


  /**
   * Default constructor.
   */
  public SearchResultReference() {}


  /**
   * Creates a new search result reference.
   *
   * @param  buffer  to decode
   */
  public SearchResultReference(final DERBuffer buffer)
  {
    final DERParser parser = new DERParser();
    parser.registerHandler(MessageIDHandler.PATH, new MessageIDHandler(this));
    parser.registerHandler(REFERRAL_URI_PATH, new ReferralUriHandler(this));
    parser.registerHandler(ControlsHandler.PATH, new ControlsHandler(this));
    parser.parse(buffer);
  }


  @Override
  public void freeze()
  {
    immutable = true;
  }


  @Override
  public boolean isFrozen()
  {
    return immutable;
  }


  @Override
  public void assertMutable()
  {
    if (immutable) {
      throw new IllegalStateException("Cannot modify immutable object");
    }
  }


  /**
   * Returns the URIs in this reference.
   *
   * @return  reference URIs
   */
  public String[] getUris()
  {
    return references.toArray(new String[0]);
  }


  /**
   * Adds a new URI to this reference.
   *
   * @param  uri  to add
   */
  public void addUris(final String... uri)
  {
    assertMutable();
    Collections.addAll(references, uri);
  }


  /**
   * Adds a new URI to this reference.
   *
   * @param  uris  to add
   */
  public void addUris(final Collection uris)
  {
    assertMutable();
    references.addAll(uris);
  }


  /**
   * Removes a URI from this reference.
   *
   * @param  uri  to remove
   */
  public void removeUris(final String... uri)
  {
    assertMutable();
    for (String s : uri) {
      references.remove(s);
    }
  }


  /**
   * Removes a URI from this reference.
   *
   * @param  uris  to remove
   */
  public void removeUris(final Collection uris)
  {
    assertMutable();
    uris.forEach(references::remove);
  }


  @Override
  public boolean equals(final Object o)
  {
    if (o == this) {
      return true;
    }
    if (o instanceof SearchResultReference && super.equals(o)) {
      final SearchResultReference v = (SearchResultReference) o;
      return LdapUtils.areEqual(references, v.references);
    }
    return false;
  }


  @Override
  public int hashCode()
  {
    return
      LdapUtils.computeHashCode(
        HASH_CODE_SEED,
        getMessageID(),
        getControls(),
        references);
  }


  @Override
  public String toString()
  {
    return super.toString() + ", " + "URIs=" + references;
  }


  /**
   * Creates a mutable copy of the supplied search result reference.
   *
   * @param  ref  to copy
   *
   * @return  new search result reference instance
   */
  public static SearchResultReference copy(final SearchResultReference ref)
  {
    final SearchResultReference copy = new SearchResultReference();
    copy.copyValues(ref);
    copy.references.addAll(ref.references);
    return copy;
  }


  /**
   * Returns a new reference whose URIs are sorted naturally.
   *
   * @param  ref  reference to sort
   *
   * @return  sorted reference
   */
  public static SearchResultReference sort(final SearchResultReference ref)
  {
    final SearchResultReference sorted = new SearchResultReference();
    sorted.copyValues(ref);
    sorted.addUris(Stream.of(ref.getUris()).sorted().collect(Collectors.toList()));
    return sorted;
  }


  /** Parse handler implementation for the referral URL. */
  protected static class ReferralUriHandler extends AbstractParseHandler
  {


    /**
     * Creates a new referral URI handler.
     *
     * @param  response  to configure
     */
    ReferralUriHandler(final SearchResultReference response)
    {
      super(response);
    }


    @Override
    public void handle(final DERParser parser, final DERBuffer encoded)
    {
      getObject().addUris(OctetStringType.decode(encoded));
    }
  }


  /**
   * Creates a builder for this class.
   *
   * @return  new builder
   */
  public static Builder builder()
  {
    return new Builder();
  }


  // CheckStyle:OFF
  public static final class Builder extends AbstractMessage.AbstractBuilder
  {


    private Builder()
    {
      super(new SearchResultReference());
    }


    @Override
    protected Builder self()
    {
      return this;
    }


    public Builder freeze()
    {
      object.freeze();
      return this;
    }


    public Builder uris(final String... uri)
    {
      object.addUris(uri);
      return this;
    }


    public Builder uris(final Collection uris)
    {
      object.addUris(uris);
      return this;
    }
  }
  // CheckStyle:ON
}