001/*
002 * Copyright 2011-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2011-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) 2011-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.ldap.sdk;
037
038
039
040import java.io.Serializable;
041
042import com.unboundid.util.Extensible;
043import com.unboundid.util.NotNull;
044import com.unboundid.util.ThreadSafety;
045import com.unboundid.util.ThreadSafetyLevel;
046
047
048
049/**
050 * This class defines an API that may be used to obtain a clear-text password
051 * that may be used for authentication or other purposes.  Passwords must be
052 * returned in the form of a byte array, and the contents of that array will be
053 * zeroed out as soon as the password is no longer required in order to minimize
054 * the length of time that the password will remain in memory.
055 */
056@Extensible()
057@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE)
058public abstract class PasswordProvider
059       implements Serializable
060{
061  /**
062   * The serial version UID for this serializable class.
063   */
064  private static final long serialVersionUID = -1582416755360005908L;
065
066
067
068  /**
069   * Retrieves a password in a newly-created byte array.  Once the password is
070   * no longer required, the contents of the array will be overwritten so that
071   * the password is no longer contained in memory.
072   *
073   * @return  A byte array containing the password that should be used.
074   *
075   * @throws  LDAPException  If a problem is encountered while attempting to
076   *                         obtain the password.
077   */
078  @NotNull()
079  public abstract byte[] getPasswordBytes()
080         throws LDAPException;
081}