InternalSearchOperation.java revision ea1068c292e9b341af6d6b563cd8988a96be20a9
/*
* 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 legal-notices/CDDLv1_0.txt
* 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 legal-notices/CDDLv1_0.txt.
* 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.
* Portions Copyright 2013-2015 ForgeRock AS
*/
/**
* This class defines a subclass of the core search operation that is
* to be used for internal searches. The primary difference between
* this class and the core search operation is that the search entries
* and references will be queued in memory rather than sent to a
* client since there is no real client.
*/
mayInstantiate=true,
mayExtend=false,
mayInvoke=true)
public final class InternalSearchOperation
extends SearchOperationBasis
{
/** The internal search listener for this search, if one was provided. */
private InternalSearchListener searchListener;
/** The set of matching entries returned for this search. */
/** The set of search references returned for this search. */
/**
* Creates a new internal search operation with the provided information.
*
* @param internalConnection
* The internal client connection with which this internal search
* operation is associated.
* @param operationID
* The operation ID for this internal search.
* @param messageID
* The message ID for this internal search.
* @param request
* The search request
*/
public InternalSearchOperation(ClientConnection internalConnection, long operationID, int messageID,
{
}
/**
* Creates a new internal search operation with the provided information.
*
* @param internalConnection The internal client connection with
* which this internal search operation
* is associated.
* @param operationID The operation ID for this internal
* search.
* @param messageID The message ID for this internal
* search.
* @param request The search request
* @param searchListener The internal search listener that
* should be used to process the
* results, or <CODE>null</CODE> if
* they should be collected internally.
*/
public InternalSearchOperation(ClientConnection internalConnection, long operationID, int messageID,
{
}
private InternalSearchOperation(
long operationID, int messageID,
{
if (searchListener == null)
{
this.searchListener = null;
}
else
{
this.searchListener = searchListener;
this.referenceList = null;
}
setInternalOperation(true);
}
/**
* Retrieves the set of search result entries returned for this
* search.
*
* @return The set of search result entries returned for this
* search, or <CODE>null</CODE> if a custom internal search
* listener is to be used.
*/
{
return entryList;
}
/**
* Provides the provided search result entry to the internal search
* listener if one was provided, or stores it in an internal list
* otherwise.
*
* @param searchEntry The search result entry returned for this
* search.
*
* @throws DirectoryException If a problem occurs while processing
* the provided entry and the search
* should be terminated.
*/
mayInstantiate=false,
mayExtend=false,
mayInvoke=false)
throws DirectoryException
{
if (searchListener == null)
{
}
else
{
}
}
/**
* Retrieves the set of search result references returned for this
* search.
*
* @return The set of search result references returned for this
* search, or <CODE>null</CODE> if a custom internal search
* listener is to be used.
*/
{
return referenceList;
}
/**
* Provides the provided search result reference to the internal
* search listener if one was provided, or stores it in an internal
* list otherwise.
*
* @param searchReference The search result reference returned for
* this search.
*
* @throws DirectoryException If a problem occurs while processing
* the provided reference and the
* search should be terminated.
*/
mayInstantiate=false,
mayExtend=false,
mayInvoke=false)
public void addSearchReference(
throws DirectoryException
{
if (searchListener == null)
{
}
else
{
}
}
/**
* Sends the provided search result entry to the client.
*
* @param searchEntry The search result entry to be sent to the
* client.
*
* @throws DirectoryException If a problem occurs while attempting
* to send the entry to the client and
* the search should be terminated.
*/
mayInstantiate=false,
mayExtend=false,
mayInvoke=false)
throws DirectoryException
{
}
/**
* Sends the provided search result reference to the client.
*
* @param searchReference The search result reference to be sent
* to the client.
*
* @return {@code true} if the client is able to accept referrals,
* or {@code false} if the client cannot handle referrals
* and no more attempts should be made to send them for the
* associated search operation.
*
* @throws DirectoryException If a problem occurs while attempting
* to send the reference to the client
* and the search should be terminated.
*/
mayInstantiate=false,
mayExtend=false,
mayInvoke=false)
public boolean sendSearchReference(
throws DirectoryException
{
return true;
}
}