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