CompareRequestProtocolOp.java revision 99faa045b6241c1d2843cce1b7a9d9c97055beae
/*
* 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
* 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
*
*
* Portions Copyright 2006-2007 Sun Microsystems, Inc.
*/
/**
* This class defines the structures and methods for an LDAP compare request
* protocol op, which is used to determine whether a particular entry contains
* a specified attribute value.
*/
public class CompareRequestProtocolOp
extends ProtocolOp
{
// The assertion value for this compare request.
private ASN1OctetString assertionValue;
// The DN for this compare request.
private ASN1OctetString dn;
// The attribute type for this compare request.
private String attributeType;
/**
* Creates a new compare request protocol op with the provided information.
*
* @param dn The DN for this compare request.
* @param attributeType The attribute type for this compare request.
* @param assertionValue The assertion value for this compare request.
*/
{
this.attributeType = attributeType;
this.assertionValue = assertionValue;
}
/**
* Retrieves the DN for this compare request.
*
* @return The DN for this compare request.
*/
public ASN1OctetString getDN()
{
return dn;
}
/**
* Specifies the DN for this compare request.
*
* @param dn The DN for this compare request.
*/
{
}
/**
* Retrieves the attribute type for this compare request.
*
* @return The attribute type for this compare request.
*/
public String getAttributeType()
{
return attributeType;
}
/**
* Specifies the attribute type for this compare request.
*
* @param attributeType The attribute type for this compare request.
*/
{
this.attributeType = attributeType;
}
/**
* Retrieves the assertion value for this compare request.
*
* @return The assertion value for this compare request.
*/
public ASN1OctetString getAssertionValue()
{
return assertionValue;
}
/**
* Specifies the assertion value for this compare request.
*
* @param assertionValue The assertion value for this compare request.
*/
{
this.assertionValue = assertionValue;
}
/**
* Retrieves the BER type for this protocol op.
*
* @return The BER type for this protocol op.
*/
public byte getType()
{
return OP_TYPE_COMPARE_REQUEST;
}
/**
* Retrieves the name for this protocol op type.
*
* @return The name for this protocol op type.
*/
public String getProtocolOpName()
{
return "Compare Request";
}
/**
* Encodes this protocol op to an ASN.1 element suitable for including in an
* LDAP message.
*
* @return The ASN.1 element containing the encoded protocol op.
*/
public ASN1Element encode()
{
}
/**
* Decodes the provided ASN.1 element as an LDAP compare request protocol op.
*
* @param element The ASN.1 element to decode.
*
* @return The decoded LDAP compare request protocol op.
*
* @throws LDAPException If a problem occurs while attempting to decode the
* ASN.1 element as a compare request protocol op.
*/
throws LDAPException
{
try
{
}
catch (Exception e)
{
if (debugEnabled())
{
}
}
if (numElements != 2)
{
}
try
{
}
catch (Exception e)
{
if (debugEnabled())
{
}
}
try
{
}
catch (Exception e)
{
if (debugEnabled())
{
}
}
if (numElements != 2)
{
}
try
{
}
catch (Exception e)
{
if (debugEnabled())
{
}
}
try
{
}
catch (Exception e)
{
if (debugEnabled())
{
}
}
}
/**
* Appends a string representation of this LDAP protocol op to the provided
* buffer.
*
* @param buffer The buffer to which the string should be appended.
*/
{
}
/**
* 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.
*/
{
for (int i=0 ; i < indent; i++)
{
}
}
}