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.protocol;
037
038
039
040import com.unboundid.ldap.sdk.Control;
041import com.unboundid.util.InternalUseOnly;
042import com.unboundid.util.NotExtensible;
043import com.unboundid.util.NotNull;
044import com.unboundid.util.ThreadSafety;
045import com.unboundid.util.ThreadSafetyLevel;
046
047
048
049/**
050 * This interface serves as a marker for classes in the
051 * {@code com.unboundid.ldap.sdk} package that are responses which may be
052 * received from a directory server.
053 *
054 */
055@InternalUseOnly()
056@NotExtensible()
057@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
058public interface LDAPResponse
059{
060  /**
061   * An empty set of controls.
062   */
063  @NotNull Control[] NO_CONTROLS = new Control[0];
064
065
066
067  /**
068   * Retrieves the message ID for the LDAP message containing this response.
069   *
070   * @return  The message ID for the LDAP message containing this response.
071   */
072  int getMessageID();
073
074
075
076  /**
077   * Appends a string representation of this LDAP response to the provided
078   * buffer.
079   *
080   * @param  buffer  The buffer to which the information should be appended.
081   */
082  void toString(@NotNull StringBuilder buffer);
083}