/*
* 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
*
*
* Copyright 2006-2008 Sun Microsystems, Inc.
*/
/**
* This class defines the structures and methods for an LDAP search result
* reference protocol op, which is used to indicate to the client that an
* alternate location or server may hold more matching entries.
*/
public class SearchResultReferenceProtocolOp
extends ProtocolOp
{
/**
* The tracer object for the debug logger.
*/
// The set of referral URLs for this search result reference.
/**
* Creates a new search result reference protocol op with the provided set of
* referral URLs.
*
* @param referralURLs The set of URLs for this search result reference.
*/
{
if (referralURLs == null)
{
}
else
{
this.referralURLs = referralURLs;
}
}
/**
* Creates a new search result reference protocol op from the provided search
* result reference object.
*
* @param searchReference The search result reference object to use to
* create this search result reference protocol op.
*/
{
if (referralURLs == null)
{
}
}
/**
* Retrieves the set of referral URLs for this search result reference
* protocol op. The returned list may be altered by the caller.
*
* @return The set of referral URLs for this search result reference protocol
* op.
*/
{
return referralURLs;
}
/**
* Retrieves the BER type for this protocol op.
*
* @return The BER type for this protocol op.
*/
public byte getType()
{
return OP_TYPE_SEARCH_RESULT_REFERENCE;
}
/**
* Retrieves the name for this protocol op type.
*
* @return The name for this protocol op type.
*/
{
return "Search Result Reference";
}
/**
* 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.
*/
{
{
}
}
/**
* Appends a string representation of this LDAP protocol op to the provided
* buffer.
*
* @param buffer The buffer to which the string should be appended.
*/
{
if (! referralURLs.isEmpty())
{
{
}
}
}
/**
* 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++)
{
}
{
}
}
}