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