001/*
002 * Copyright 2017-2023 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2017-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) 2017-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.listener;
037
038
039
040import com.unboundid.ldap.sdk.LDAPException;
041import com.unboundid.util.Extensible;
042import com.unboundid.util.NotNull;
043import com.unboundid.util.ThreadSafety;
044import com.unboundid.util.ThreadSafetyLevel;
045
046
047
048/**
049 * This class defines an API that may be used to format and un-format encoded
050 * passwords for use with the in-memory directory server.
051 */
052@Extensible()
053@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
054public abstract class PasswordEncoderOutputFormatter
055{
056  /**
057   * Formats the provided data in accordance with this output format.
058   *
059   * @param  unformattedData  The data to be formatted.  It must not be
060   *                          {@code null}.
061   *
062   * @return  A formatted representation of the provided data.
063   *
064   * @throws  LDAPException  If a problem is encountered while formatting the
065   *                         provided data.
066   */
067  @NotNull()
068  public abstract byte[] format(@NotNull byte[] unformattedData)
069         throws LDAPException;
070
071
072
073  /**
074   * Reverses the formatting that has been applied to the provided data.
075   *
076   * @param  formattedData  The formatted data to be un-formatted.  It must not
077   *                        be {@code null}.
078   *
079   * @return  The un-formatted version of the provided data.
080   *
081   * @throws  LDAPException  If the provided data does not represent a valid
082   *                         encoding, or if a problem is encountered while
083   *                         un-formatting the provided data.
084   */
085  @NotNull()
086  public abstract byte[] unFormat(@NotNull byte[] formattedData)
087         throws LDAPException;
088
089
090
091  /**
092   * Retrieves a string representation of this password encoder output
093   * formatter.
094   *
095   * @return  A string representation of this password encoder output formatter.
096   */
097  @Override()
098  @NotNull()
099  public final String toString()
100  {
101    final StringBuilder buffer = new StringBuilder();
102    toString(buffer);
103    return buffer.toString();
104  }
105
106
107
108  /**
109   * Appends a string representation of this password encoder output formatter
110   * to the provided buffer.
111   *
112   * @param  buffer  The buffer to which the information should be appended.
113   */
114  public abstract void toString(@NotNull StringBuilder buffer);
115}