001/*
002 * Copyright 2010-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2010-2024 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2010-2024 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldap.sdk.unboundidds.extensions;
037
038
039
040import java.util.Date;
041
042import com.unboundid.asn1.ASN1Element;
043import com.unboundid.asn1.ASN1OctetString;
044import com.unboundid.util.NotMutable;
045import com.unboundid.util.NotNull;
046import com.unboundid.util.ThreadSafety;
047import com.unboundid.util.ThreadSafetyLevel;
048import com.unboundid.util.StaticUtils;
049
050
051
052/**
053 * This class provides an implementation of a changelog batch starting point
054 * which may be used to start a batch of changes at a specified time.  The first
055 * change of the batch will be the first change on any server with a change time
056 * greater than or equal to the specified time.
057 * <BR>
058 * <BLOCKQUOTE>
059 *   <B>NOTE:</B>  This class, and other classes within the
060 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
061 *   supported for use against Ping Identity, UnboundID, and
062 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
063 *   for proprietary functionality or for external specifications that are not
064 *   considered stable or mature enough to be guaranteed to work in an
065 *   interoperable way with other types of LDAP servers.
066 * </BLOCKQUOTE>
067 */
068@NotMutable()
069@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
070public final class ChangeTimeStartingPoint
071       extends ChangelogBatchStartingPoint
072{
073  /**
074   * The BER type to use for the ASN.1 element used to encode this starting
075   * point.
076   */
077  static final byte TYPE = (byte) 0x84;
078
079
080
081  /**
082   * The serial version UID for this serializable class.
083   */
084  private static final long serialVersionUID = 920153185766534528L;
085
086
087
088  // The time that defines the starting point for the changelog batch request.
089  private final long changeTime;
090
091  // The string representation of the start time, using the generalized time
092  // syntax.
093  @NotNull private final String changeTimeString;
094
095
096
097  /**
098   * Creates a new instance of this changelog starting point using the provided
099   * start time.
100   *
101   * @param  changeTime  The time of the oldest change which may be used as the
102   *                     starting point for the batch of changes.
103   */
104  public ChangeTimeStartingPoint(final long changeTime)
105  {
106    this.changeTime = changeTime;
107
108    changeTimeString = StaticUtils.encodeGeneralizedTime(new Date(changeTime));
109  }
110
111
112
113  /**
114   * Retrieves the time of the oldest change which may be used as the starting
115   * point for the batch of changes.
116   *
117   * @return  The time of the oldest change which may be used as the starting
118   *          point for the batch of changes.
119   */
120  public long getChangeTime()
121  {
122    return changeTime;
123  }
124
125
126
127  /**
128   * {@inheritDoc}
129   */
130  @Override()
131  @NotNull()
132  public ASN1Element encode()
133  {
134    return new ASN1OctetString(TYPE, changeTimeString);
135  }
136
137
138
139  /**
140   * {@inheritDoc}
141   */
142  @Override()
143  public void toString(@NotNull final StringBuilder buffer)
144  {
145    buffer.append("ChangeTimeStartingPoint(time='");
146    buffer.append(changeTimeString);
147    buffer.append("')");
148  }
149}