001/*
002 * Copyright 2016-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2016-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) 2016-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.ldif;
037
038
039
040import java.util.ArrayList;
041import java.util.Collection;
042import java.util.Collections;
043import java.util.List;
044
045import com.unboundid.util.NotNull;
046import com.unboundid.util.Nullable;
047import com.unboundid.util.StaticUtils;
048import com.unboundid.util.ThreadSafety;
049import com.unboundid.util.ThreadSafetyLevel;
050
051
052
053/**
054 * This class provides an implementation of an LDIF reader change record
055 * translator that can be used to invoke multiple LDIF reader change record
056 * translators for each record to be processed.
057 */
058@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
059public final class AggregateLDIFReaderChangeRecordTranslator
060       implements LDIFReaderChangeRecordTranslator
061{
062  // The set of LDIF reader change record translators to be invoked for each
063  // record to process.
064  @NotNull private final List<LDIFReaderChangeRecordTranslator> translators;
065
066
067
068  /**
069   * Creates a new aggregate LDIF reader change record translator that will
070   * invoke all of the provided translators for each record to be processed.
071   *
072   * @param  translators  The set of LDIF reader change record translators to be
073   *                      invoked for each record to be processed.
074   */
075  public AggregateLDIFReaderChangeRecordTranslator(
076              @Nullable final LDIFReaderChangeRecordTranslator... translators)
077  {
078    this(StaticUtils.toList(translators));
079  }
080
081
082
083  /**
084   * Creates a new aggregate LDIF reader change record translator that will
085   * invoke all of the provided translators for each record to be processed.
086   *
087   * @param  translators  The set of LDIF reader change record translators to be
088   *                      invoked for each record to be processed.
089   */
090  public AggregateLDIFReaderChangeRecordTranslator(
091       @Nullable final Collection<? extends LDIFReaderChangeRecordTranslator>
092            translators)
093  {
094    if (translators == null)
095    {
096      this.translators = Collections.emptyList();
097    }
098    else
099    {
100      this.translators =
101           Collections.unmodifiableList(new ArrayList<>(translators));
102    }
103  }
104
105
106
107  /**
108   * {@inheritDoc}
109   */
110  @Override()
111  @Nullable()
112  public LDIFChangeRecord translate(@NotNull  final LDIFChangeRecord original,
113                                    final long firstLineNumber)
114         throws LDIFException
115  {
116    if (original == null)
117    {
118      return null;
119    }
120
121    LDIFChangeRecord r = original;
122    for (final LDIFReaderChangeRecordTranslator t : translators)
123    {
124      r = t.translate(r, firstLineNumber);
125      if (r == null)
126      {
127        return null;
128      }
129    }
130
131    return r;
132  }
133}