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 java.util.Date; 041 042import com.unboundid.asn1.ASN1Element; 043import com.unboundid.asn1.ASN1OctetString; 044import com.unboundid.util.NotMutable; 045import com.unboundid.util.ThreadSafety; 046import com.unboundid.util.ThreadSafetyLevel; 047import com.unboundid.util.StaticUtils; 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 specified time. The first 054 * change of the batch will be the first change on any server with a change time 055 * greater than or equal to the specified time. 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 ChangeTimeStartingPoint 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) 0x84; 077 078 079 080 /** 081 * The serial version UID for this serializable class. 082 */ 083 private static final long serialVersionUID = 920153185766534528L; 084 085 086 087 // The time that defines the starting point for the changelog batch request. 088 private final long changeTime; 089 090 // The string representation of the start time, using the generalized time 091 // syntax. 092 private final String changeTimeString; 093 094 095 096 /** 097 * Creates a new instance of this changelog starting point using the provided 098 * start time. 099 * 100 * @param changeTime The time of the oldest change which may be used as the 101 * starting point for the batch of changes. 102 */ 103 public ChangeTimeStartingPoint(final long changeTime) 104 { 105 this.changeTime = changeTime; 106 107 changeTimeString = StaticUtils.encodeGeneralizedTime(new Date(changeTime)); 108 } 109 110 111 112 /** 113 * Retrieves the time of the oldest change which may be used as the starting 114 * point for the batch of changes. 115 * 116 * @return The time of the oldest change which may be used as the starting 117 * point for the batch of changes. 118 */ 119 public long getChangeTime() 120 { 121 return changeTime; 122 } 123 124 125 126 /** 127 * {@inheritDoc} 128 */ 129 @Override() 130 public ASN1Element encode() 131 { 132 return new ASN1OctetString(TYPE, changeTimeString); 133 } 134 135 136 137 /** 138 * {@inheritDoc} 139 */ 140 @Override() 141 public void toString(final StringBuilder buffer) 142 { 143 buffer.append("ChangeTimeStartingPoint(time='"); 144 buffer.append(changeTimeString); 145 buffer.append("')"); 146 } 147}