com.unboundid.ldap.sdk.unboundidds.extensions.ChangeTimeStartingPoint Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of unboundid-ldapsdk-commercial-edition 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 Commercial Edition of the LDAP SDK, which includes all of the general-purpose functionality contained in the Standard Edition, plus additional functionality specific to UnboundID server products.

The newest version!

/*
 * Copyright 2010-2017 UnboundID Corp.
 * All Rights Reserved.
 */
/*
 * Copyright (C) 2015-2017 UnboundID Corp.
 *
 * 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.unboundidds.extensions;



import java.util.Date;

import com.unboundid.asn1.ASN1Element;
import com.unboundid.asn1.ASN1OctetString;
import com.unboundid.util.NotMutable;
import com.unboundid.util.ThreadSafety;
import com.unboundid.util.ThreadSafetyLevel;
import com.unboundid.util.StaticUtils;



/**
 * This class provides an implementation of a changelog batch starting point
 * which may be used to start a batch of changes at a specified time.  The first
 * change of the batch will be the first change on any server with a change time
 * greater than or equal to the specified time.
 * 

 * 
 *   NOTE:  This class is part of the Commercial Edition of the UnboundID
 *   LDAP SDK for Java.  It is not available for use in applications that
 *   include only the Standard Edition of the LDAP SDK, and is not supported for
 *   use in conjunction with non-UnboundID products.
 * 
 */
@NotMutable()
@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
public final class ChangeTimeStartingPoint
       extends ChangelogBatchStartingPoint
{
  /**
   * The BER type to use for the ASN.1 element used to encode this starting
   * point.
   */
  static final byte TYPE = (byte) 0x84;



  /**
   * The serial version UID for this serializable class.
   */
  private static final long serialVersionUID = 920153185766534528L;



  // The time that defines the starting point for the changelog batch request.
  private final long changeTime;

  // The string representation of the start time, using the generalized time
  // syntax.
  private final String changeTimeString;



  /**
   * Creates a new instance of this changelog starting point using the provided
   * start time.
   *
   * @param  changeTime  The time of the oldest change which may be used as the
   *                     starting point for the batch of changes.
   */
  public ChangeTimeStartingPoint(final long changeTime)
  {
    this.changeTime = changeTime;

    changeTimeString = StaticUtils.encodeGeneralizedTime(new Date(changeTime));
  }



  /**
   * Retrieves the time of the oldest change which may be used as the starting
   * point for the batch of changes.
   *
   * @return  The time of the oldest change which may be used as the starting
   *          point for the batch of changes.
   */
  public long getChangeTime()
  {
    return changeTime;
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  public ASN1Element encode()
  {
    return new ASN1OctetString(TYPE, changeTimeString);
  }



  /**
   * {@inheritDoc}
   */
  @Override()
  public void toString(final StringBuilder buffer)
  {
    buffer.append("ChangeTimeStartingPoint(time='");
    buffer.append(changeTimeString);
    buffer.append("')");
  }
}