001/* 002 * Copyright 2007-2020 Ping Identity Corporation 003 * All Rights Reserved. 004 */ 005/* 006 * Copyright 2007-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) 2008-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; 037 038 039 040import java.io.Serializable; 041 042import com.unboundid.asn1.ASN1OctetString; 043import com.unboundid.util.Extensible; 044import com.unboundid.util.ThreadSafety; 045import com.unboundid.util.ThreadSafetyLevel; 046 047 048 049/** 050 * This interface defines a method that may be implemented by controls that may 051 * be included in the response from a directory server. The LDAP SDK will 052 * maintain a mapping between response control OIDs and the decodeable control 053 * classes that may be used to attempt to decode them. If a control cannot be 054 * decoded using this interface and an exception is thrown, then it will be 055 * treated as a generic control. 056 */ 057@Extensible() 058@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_THREADSAFE) 059public interface DecodeableControl 060 extends Serializable 061{ 062 /** 063 * Creates a new instance of this decodeable control from the provided 064 * information. 065 * 066 * @param oid The OID for the control. 067 * @param isCritical Indicates whether the control should be marked 068 * critical. 069 * @param value The encoded value for the control. This may be 070 * {@code null} if no value was provided. 071 * 072 * @return The decoded representation of this control. 073 * 074 * @throws LDAPException If the provided information cannot be decoded as a 075 * valid instance of this decodeable control. 076 */ 077 Control decodeControl(String oid, boolean isCritical, ASN1OctetString value) 078 throws LDAPException; 079}