001/*
002 * Copyright 2009-2024 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2009-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) 2009-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.migrate.ldapjdk;
037
038
039
040import java.io.Serializable;
041
042import com.unboundid.util.NotExtensible;
043import com.unboundid.util.NotMutable;
044import com.unboundid.util.Nullable;
045import com.unboundid.util.ThreadSafety;
046import com.unboundid.util.ThreadSafetyLevel;
047
048
049
050/**
051 * This class provides a data structure that may be used when authenticating a
052 * connection used to follow a referral.
053 * <BR><BR>
054 * This class is primarily intended to be used in the process of updating
055 * applications which use the Netscape Directory SDK for Java to switch to or
056 * coexist with the UnboundID LDAP SDK for Java.  For applications not written
057 * using the Netscape Directory SDK for Java, the
058 * {@link com.unboundid.ldap.sdk.ReferralConnector} class should be used
059 * instead.
060 */
061@NotExtensible()
062@NotMutable()
063@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
064public class LDAPRebindAuth
065       implements Serializable
066{
067  /**
068   * The serial version UID to use for this serializable class.
069   */
070  private static final long serialVersionUID = -844389460595019929L;
071
072
073
074  // The DN to use when authenticating.
075  @Nullable private final String dn;
076
077  // The password to use when authenticating.
078  @Nullable private final String password;
079
080
081
082  /**
083   * Creates a new LDAP rebind auth object with the provided information.
084   *
085   * @param  dn        The DN to use when authenticating.
086   * @param  password  The password to use when authenticating.
087   */
088  public LDAPRebindAuth(@Nullable final String dn,
089                        @Nullable final String password)
090  {
091    this.dn       = dn;
092    this.password = password;
093  }
094
095
096
097  /**
098   * Retrieves the DN to use when authenticating.
099   *
100   * @return  The DN to use when authenticating.
101   */
102  @Nullable()
103  public String getDN()
104  {
105    return dn;
106  }
107
108
109
110  /**
111   * Retrieves the password to use when authenticating.
112   *
113   * @return  The password to use when authenticating.
114   */
115  @Nullable()
116  public String getPassword()
117  {
118    return password;
119  }
120}