001/*
002 * Copyright 2016-2023 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2016-2023 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-2023 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.transformations;
037
038
039
040import com.unboundid.ldif.LDIFChangeRecord;
041import com.unboundid.ldif.LDIFReaderChangeRecordTranslator;
042import com.unboundid.ldif.LDIFWriterChangeRecordTranslator;
043import com.unboundid.util.Extensible;
044import com.unboundid.util.NotNull;
045import com.unboundid.util.Nullable;
046import com.unboundid.util.ThreadSafety;
047import com.unboundid.util.ThreadSafetyLevel;
048
049
050
051/**
052 * This class defines an API that may be used to apply some kind of
053 * transformation to an LDIF change record to alter its contents or suppress it
054 * from further processing.
055 */
056@Extensible()
057@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
058public interface LDIFChangeRecordTransformation
059       extends LDIFReaderChangeRecordTranslator,
060               LDIFWriterChangeRecordTranslator
061{
062  /**
063   * Applies an appropriate transformation to the provided LDIF change record.
064   *
065   * @param  changeRecord  The LDIF change record to transform.
066   *
067   * @return  A copy of the change record with any appropriate transformation
068   *          applied, the original change record if no transformations were
069   *          necessary, or {@code null} if the change record should be
070   *          suppressed.
071   */
072  @Nullable()
073  LDIFChangeRecord transformChangeRecord(
074                        @NotNull LDIFChangeRecord changeRecord);
075}