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 com.unboundid.asn1.ASN1OctetString;
041import com.unboundid.ldap.sdk.ExtendedResult;
042import com.unboundid.util.Extensible;
043import com.unboundid.util.NotMutable;
044import com.unboundid.util.NotNull;
045import com.unboundid.util.Nullable;
046import com.unboundid.util.ThreadSafety;
047import com.unboundid.util.ThreadSafetyLevel;
048
049
050
051/**
052 * This class provides a data structure which represents an LDAP extended
053 * response.
054 * <BR><BR>
055 * This class is primarily intended to be used in the process of updating
056 * applications which use the Netscape Directory SDK for Java to switch to or
057 * coexist with the UnboundID LDAP SDK for Java.  For applications not written
058 * using the Netscape Directory SDK for Java, the {@link ExtendedResult} class
059 * should be used instead.
060 */
061@Extensible()
062@NotMutable()
063@ThreadSafety(level=ThreadSafetyLevel.COMPLETELY_THREADSAFE)
064public class LDAPExtendedResponse
065       extends LDAPResponse
066{
067  /**
068   * The serial version UID for this serializable class.
069   */
070  private static final long serialVersionUID = 7956345950545720834L;
071
072
073
074  // The extended result for this LDAP extended response.
075  @NotNull private final ExtendedResult extendedResult;
076
077
078
079  /**
080   * Creates a new LDAP extended response from the provided
081   * {@link ExtendedResult} object.
082   *
083   * @param  extendedResult  The {@code ExtendedResult} to use to create this
084   *                         LDAP extended response.
085   */
086  public LDAPExtendedResponse(@NotNull final ExtendedResult extendedResult)
087  {
088    super(extendedResult);
089
090    this.extendedResult = extendedResult;
091  }
092
093
094
095  /**
096   * Retrieves the OID for this LDAP extended response, if any.
097   *
098   * @return  The OID for this LDAP extended response, or {@code null} if there
099   *          is none.
100   */
101  @Nullable()
102  public String getID()
103  {
104    return extendedResult.getOID();
105  }
106
107
108
109  /**
110   * Retrieves the value for this LDAP extended response, if any.
111   *
112   * @return  The value for this LDAP extended response, or {@code null} if
113   *          there is none.
114   */
115  @Nullable()
116  public byte[] getValue()
117  {
118    final ASN1OctetString value = extendedResult.getValue();
119    if (value == null)
120    {
121      return null;
122    }
123    else
124    {
125      return value.getValue();
126    }
127  }
128
129
130
131  /**
132   * Retrieves an {@link ExtendedResult} object that is the equivalent of this
133   * LDAP extended response.
134   *
135   * @return  An {@code ExtendedResult} object that is the equivalent of this
136   *          LDAP extended response.
137   */
138  @NotNull()
139  public final ExtendedResult toExtendedResult()
140  {
141    return extendedResult;
142  }
143
144
145
146  /**
147   * Retrieves a string representation of this LDAP extended response.
148   *
149   * @return  A string representation of this LDAP extended response.
150   */
151  @Override()
152  @NotNull()
153  public String toString()
154  {
155    return extendedResult.toString();
156  }
157}