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