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