/*
* CDDL HEADER START
*
* The contents of this file are subject to the terms of the
* Common Development and Distribution License, Version 1.0 only
* (the "License"). You may not use this file except in compliance
* with the License.
*
* You can obtain a copy of the license at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE
* or https://OpenDS.dev.java.net/OpenDS.LICENSE.
* See the License for the specific language governing permissions
* and limitations under the License.
*
* When distributing Covered Code, include this CDDL HEADER in each
* file and include the License file at
* trunk/opends/resource/legal-notices/OpenDS.LICENSE. If applicable,
* add the following below this CDDL HEADER, with the fields enclosed
* by brackets "[]" replaced with your own identifying information:
* Portions Copyright [yyyy] [name of copyright owner]
*
* CDDL HEADER END
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
*/
package org.opends.server.protocols.ldap;
import org.opends.server.protocols.asn1.ASN1Writer;
import java.io.IOException;
/**
* This class defines the structures and methods for an LDAP protocol op, which
* is the core of an LDAP message.
*/
public abstract class ProtocolOp
{
/**
* Retrieves the BER type for this protocol op.
*
* @return The BER type for this protocol op.
*/
public abstract byte getType();
/**
* Retrieves the name for this protocol op type.
*
* @return The name for this protocol op type.
*/
public abstract String getProtocolOpName();
/**
* Writes this protocol op to an ASN.1 output stream.
*
* @param stream The ASN.1 output stream to write to.
* @throws IOException If a problem occurs while writing to the stream.
*/
public abstract void write(ASN1Writer stream) throws IOException;
/**
* Retrieves a string representation of this LDAP protocol op.
*
* @return A string representation of this LDAP protocol op.
*/
public String toString()
{
StringBuilder buffer = new StringBuilder();
toString(buffer);
return buffer.toString();
}
/**
* Appends a string representation of this LDAP protocol op to the provided
* buffer.
*
* @param buffer The buffer to which the string should be appended.
*/
public abstract void toString(StringBuilder buffer);
/**
* Appends a multi-line string representation of this LDAP protocol op to the
* provided buffer.
*
* @param buffer The buffer to which the information should be appended.
* @param indent The number of spaces from the margin that the lines should
* be indented.
*/
public abstract void toString(StringBuilder buffer, int indent);
}