CompareOperationBasis.java revision 90a6ab6c63699343acf3adcd4346bce2f5665bdd
/*
* 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 2007-2010 Sun Microsystems, Inc.
* Portions Copyright 2013-2015 ForgeRock AS
*/
/**
* This class defines an operation that may be used to determine whether a
* specified entry in the Directory Server contains a given attribute-value
* pair.
*/
public class CompareOperationBasis
extends AbstractOperation
implements PreParseCompareOperation, CompareOperation,
{
/** The attribute type for this compare operation. */
private AttributeType attributeType;
/** The assertion value for the compare operation. */
private ByteString assertionValue;
/** The set of attribute options. */
/** The raw, unprocessed entry DN as included in the client request. */
private ByteString rawEntryDN;
/** The DN of the entry for the compare operation. */
/** The proxied authorization target DN for this operation. */
private DN proxiedAuthorizationDN;
/** The set of response controls for this compare operation. */
/** The attribute type for the compare operation. */
private String rawAttributeType;
/**
* Creates a new compare operation with the provided information.
*
* @param clientConnection The client connection with which this operation
* is associated.
* @param operationID The operation ID for this operation.
* @param messageID The message ID of the request with which this
* operation is associated.
* @param requestControls The set of controls included in the request.
* @param rawEntryDN The raw, unprocessed entry DN as provided in the
* client request. This may or may not be a valid
* DN as no validation will have been performed yet.
* @param rawAttributeType The raw attribute type for the compare operation.
* @param assertionValue The assertion value for the compare operation.
*/
public CompareOperationBasis(
{
this.rawEntryDN = rawEntryDN;
this.rawAttributeType = rawAttributeType;
this.assertionValue = assertionValue;
responseControls = new ArrayList<>();
}
/**
* Creates a new compare operation with the provided information.
*
* @param clientConnection The client connection with which this operation
* is associated.
* @param operationID The operation ID for this operation.
* @param messageID The message ID of the request with which this
* operation is associated.
* @param requestControls The set of controls included in the request.
* @param entryDN The entry DN for this compare operation.
* @param attributeType The attribute type for this compare operation.
* @param assertionValue The assertion value for the compare operation.
*/
public CompareOperationBasis(
{
this.attributeType = attributeType;
this.assertionValue = assertionValue;
responseControls = new ArrayList<>();
attributeOptions = new HashSet<>();
}
/** {@inheritDoc} */
public final ByteString getRawEntryDN()
{
return rawEntryDN;
}
/** {@inheritDoc} */
{
this.rawEntryDN = rawEntryDN;
}
/** {@inheritDoc} */
public final DN getEntryDN()
{
try
{
}
catch (DirectoryException de)
{
}
}
return entryDN;
}
/** {@inheritDoc} */
public final String getRawAttributeType()
{
return rawAttributeType;
}
/** {@inheritDoc} */
{
this.rawAttributeType = rawAttributeType;
}
private void getAttributeTypeAndOptions() {
if (semicolonPos > 0) {
attributeOptions = new HashSet<>();
while (nextPos > 0)
{
}
}
else
{
}
}
/** {@inheritDoc} */
public final AttributeType getAttributeType()
{
if (attributeType == null) {
}
return attributeType;
}
/** {@inheritDoc} */
{
this.attributeType = attributeType;
}
/** {@inheritDoc} */
{
if (attributeOptions == null) {
}
return attributeOptions;
}
/** {@inheritDoc} */
{
this.attributeOptions = attributeOptions;
}
/** {@inheritDoc} */
public final ByteString getAssertionValue()
{
return assertionValue;
}
/** {@inheritDoc} */
{
this.assertionValue = assertionValue;
}
/** {@inheritDoc} */
public final OperationType getOperationType()
{
// Note that no debugging will be done in this method because it is a likely
// candidate for being called by the logging subsystem.
return OperationType.COMPARE;
}
/**
* Retrieves the proxied authorization DN for this operation if proxied
* authorization has been requested.
*
* @return The proxied authorization DN for this operation if proxied
* authorization has been requested, or {@code null} if proxied
* authorization has not been requested.
*/
public DN getProxiedAuthorizationDN()
{
return proxiedAuthorizationDN;
}
/** {@inheritDoc} */
{
}
/** {@inheritDoc} */
{
return responseControls;
}
/** {@inheritDoc} */
{
}
/** {@inheritDoc} */
{
}
/**
* Performs the work of actually processing this operation. This
* should include all processing for the operation, including
* invoking plugins, logging messages, performing access control,
* managing synchronization, and any other work that might need to
* be done in the course of processing.
*/
public final void run()
{
// Start the processing timer.
// Log the compare request message.
logCompareRequest(this);
// Get the plugin config manager that will be used for invoking plugins.
// This flag is set to true as soon as a workflow has been executed.
boolean workflowExecuted = false;
try
{
// Check for and handle a request to cancel this operation.
checkIfCanceled(false);
// Invoke the pre-parse compare plugins.
if(!preParseResult.continueProcessing())
{
return;
}
// Check for a request to cancel this operation.
checkIfCanceled(false);
// Process the entry DN to convert it from the raw form to the form
// required for the rest of the compare processing.
try
{
{
}
}
catch (DirectoryException de)
{
return;
}
}
catch(CanceledOperationException coe)
{
}
finally
{
// Stop the processing timer.
// Log the compare response message.
logCompareResponse(this);
{
clientConnection.sendResponse(this);
}
// Invoke the post-response compare plugins.
// If no cancel result, set it
if(cancelResult == null)
{
}
}
}
/**
* Invokes the post response plugins. If a workflow has been executed
* then invoke the post response plugins provided by the workflow
* elements of the workflow, otherwise invoke the post response plugins
* that have been registered with the current operation.
*
* @param workflowExecuted <code>true</code> if a workflow has been executed
*/
private void invokePostResponsePlugins(boolean workflowExecuted)
{
// Get the plugin config manager that will be used for invoking plugins.
// Invoke the post response plugins
if (workflowExecuted)
{
// Invoke the post response plugins that have been registered by
// the workflow elements
if (localOperations != null)
{
{
}
}
}
else
{
// Invoke the post response plugins that have been registered with
// the current operation
}
}
/**
* Updates the error message and the result code of the operation.
*
* This method is called because no workflow was found to process
* the operation.
*/
public void updateOperationErrMsgAndResCode()
{
}
/** {@inheritDoc} */
{
}
/**
* {@inheritDoc}
*
* This method always returns null.
*/
public Entry getEntryToCompare()
{
return null;
}
}