001/*
002 * Copyright 2010-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2010-2022 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-2022 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 com.unboundid.asn1.ASN1Element;
041import com.unboundid.asn1.ASN1OctetString;
042import com.unboundid.util.Base64;
043import com.unboundid.util.NotMutable;
044import com.unboundid.util.NotNull;
045import com.unboundid.util.ThreadSafety;
046import com.unboundid.util.ThreadSafetyLevel;
047import com.unboundid.util.Validator;
048
049
050
051/**
052 * This class provides an implementation of a changelog batch starting point
053 * which may be used to start a batch of changes at a point where a previous
054 * batch ended.  The first change of the batch will be the change immediately
055 * after the change associated with the provided token.
056 * <BR>
057 * <BLOCKQUOTE>
058 *   <B>NOTE:</B>  This class, and other classes within the
059 *   {@code com.unboundid.ldap.sdk.unboundidds} package structure, are only
060 *   supported for use against Ping Identity, UnboundID, and
061 *   Nokia/Alcatel-Lucent 8661 server products.  These classes provide support
062 *   for proprietary functionality or for external specifications that are not
063 *   considered stable or mature enough to be guaranteed to work in an
064 *   interoperable way with other types of LDAP servers.
065 * </BLOCKQUOTE>
066 */
067@NotMutable()
068@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
069public final class ResumeWithTokenStartingPoint
070       extends ChangelogBatchStartingPoint
071{
072  /**
073   * The BER type to use for the ASN.1 element used to encode this starting
074   * point.
075   */
076  static final byte TYPE = (byte) 0x80;
077
078
079
080  /**
081   * The serial version UID for this serializable class.
082   */
083  private static final long serialVersionUID = -101217605840282165L;
084
085
086
087  // The content of the token to use when resuming a batch.
088  @NotNull private final ASN1OctetString resumeToken;
089
090
091
092  /**
093   * Creates a new instance of this changelog batch starting point using the
094   * provided resume token.
095   *
096   * @param  resumeToken  The token which may be used to resume changelog access
097   *                      at the point where it previously ended.  It must not
098   *                      be {@code null}.
099   */
100  public ResumeWithTokenStartingPoint(
101              @NotNull final ASN1OctetString resumeToken)
102  {
103    Validator.ensureNotNull(resumeToken);
104
105    this.resumeToken = resumeToken;
106  }
107
108
109
110  /**
111   * Retrieves the token which may be used to resume changelog access at the
112   * point where it previously ended.
113   *
114   * @return  The token which may be used to resume changelog access at the
115   *          point where it previously ended.
116   */
117  @NotNull()
118  public ASN1OctetString getResumeToken()
119  {
120    return resumeToken;
121  }
122
123
124
125  /**
126   * {@inheritDoc}
127   */
128  @Override()
129  @NotNull()
130  public ASN1Element encode()
131  {
132    return new ASN1OctetString(TYPE, resumeToken.getValue());
133  }
134
135
136
137  /**
138   * {@inheritDoc}
139   */
140  @Override()
141  public void toString(@NotNull final StringBuilder buffer)
142  {
143    buffer.append("ResumeWithTokenStartingPoint(token='");
144    Base64.encode(resumeToken.getValue(), buffer);
145    buffer.append("')");
146  }
147}