CompareOperation.java revision b1dce270ec218b8ad86ce6d745d295da038a5c88
/*
* 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-2009 Sun Microsystems, Inc.
* Portions Copyright 2014 ForgeRock AS
*/
/**
* This interface defines an operation that may be used to determine whether a
* specified entry in the Directory Server contains a given attribute-value
* pair.
*/
public interface CompareOperation extends Operation
{
/**
* Retrieves the raw, unprocessed entry DN as included in the client request.
* The DN that is returned may or may not be a valid DN, since no validation
* will have been performed upon it.
*
* @return The raw, unprocessed entry DN as included in the client request.
*/
public ByteString getRawEntryDN();
/**
* Specifies the raw, unprocessed entry DN as included in the client request.
* This should only be called by pre-parse plugins.
*
* @param rawEntryDN The raw, unprocessed entry DN as included in the client
* request.
*/
/**
* Retrieves the DN of the entry to compare. This should not be called by
* pre-parse plugins because the processed DN will not be available yet.
* Instead, they should call the <CODE>getRawEntryDN</CODE> method.
*
* @return The DN of the entry to compare, or <CODE>null</CODE> if the raw
* entry DN has not yet been processed.
*/
public DN getEntryDN();
/**
* Retrieves the raw attribute type for this compare operation.
*
* @return The raw attribute type for this compare operation.
*/
public String getRawAttributeType();
/**
* Specifies the raw attribute type for this compare operation. This should
* only be called by pre-parse plugins.
*
* @param rawAttributeType The raw attribute type for this compare
* operation.
*/
/**
* Retrieves the attribute type for this compare operation. This should not
* be called by pre-parse plugins because the processed attribute type will
* not be available yet.
*
* @return The attribute type for this compare operation.
*/
public AttributeType getAttributeType();
/**
* Specifies the attribute type for this compare operation.
*
* @param attributeType The attribute type for this compare operation.
*/
/**
* Retrieves the attribute options for this compare operation. This should
* not be called by the pre-parse plugins because the processed attribute
* options will not be available yet.
*
* @return The attribute options for this compare operation.
*/
/**
* Specifies the attribute options for this compare operation.
*
* @param attributeOptions The attribute options for this compare operation.
*/
/**
* Retrieves the assertion value for this compare operation.
*
* @return The assertion value for this compare operation.
*/
public ByteString getAssertionValue();
/**
* Specifies the assertion value for this compare operation. This should only
* be called by pre-parse and pre-operation plugins.
*
* @param assertionValue The assertion value for this compare operation.
*/
/**
* Retrieves the proxied authorization target DN for this compare operation.
*
* @return The proxied authorization target DN for this compare operation
*/
public DN getProxiedAuthorizationDN();
/**
* Specifies the proxied authorization target DN for this compare operation.
*
* @param proxiedAuthorizationDN The proxied authorization target DN for
* this compare operation
*/
}