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.protocol; 037 038 039 040import java.io.Serializable; 041 042import com.unboundid.asn1.ASN1Buffer; 043import com.unboundid.asn1.ASN1Element; 044import com.unboundid.util.InternalUseOnly; 045import com.unboundid.util.NotExtensible; 046import com.unboundid.util.ThreadSafety; 047import com.unboundid.util.ThreadSafetyLevel; 048 049 050 051/** 052 * This interface defines a set of methods that should be implemented by all 053 * types of LDAP protocol ops. 054 */ 055@InternalUseOnly() 056@NotExtensible() 057@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE) 058public interface ProtocolOp 059 extends Serializable 060{ 061 /** 062 * Retrieves the BER type for this protocol op. 063 * 064 * @return The BER type for this protocol op. 065 */ 066 byte getProtocolOpType(); 067 068 069 070 /** 071 * Encodes this protocol op to an ASN.1 element suitable for inclusion in an 072 * encoded LDAP message. 073 * 074 * @return The ASN.1 element containing the encoded protocol op. 075 */ 076 ASN1Element encodeProtocolOp(); 077 078 079 080 /** 081 * Writes an ASN.1-encoded representation of this LDAP protocol op to the 082 * provided ASN.1 buffer. This method is intended for internal use only and 083 * should not be used by third-party code. 084 * 085 * @param buffer The ASN.1 buffer to which the encoded representation should 086 * be written. 087 */ 088 void writeTo(ASN1Buffer buffer); 089 090 091 092 /** 093 * Appends a string representation of this LDAP protocol op to the provided 094 * buffer. 095 * 096 * @param buffer The buffer to which the string representation should be 097 * appended. 098 */ 099 void toString(StringBuilder buffer); 100}