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