0N/A/*
0N/A * CDDL HEADER START
0N/A *
0N/A * The contents of this file are subject to the terms of the
0N/A * Common Development and Distribution License, Version 1.0 only
0N/A * (the "License"). You may not use this file except in compliance
0N/A * with the License.
0N/A *
6983N/A * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
6983N/A * or http://forgerock.org/license/CDDLv1.0.html.
0N/A * See the License for the specific language governing permissions
0N/A * and limitations under the License.
0N/A *
0N/A * When distributing Covered Code, include this CDDL HEADER in each
6983N/A * file and include the License file at legal-notices/CDDLv1_0.txt.
6983N/A * If applicable, add the following below this CDDL HEADER, with the
6983N/A * fields enclosed by brackets "[]" replaced with your own identifying
6983N/A * information:
0N/A * Portions Copyright [yyyy] [name of copyright owner]
0N/A *
0N/A * CDDL HEADER END
0N/A *
0N/A *
4899N/A * Copyright 2006-2009 Sun Microsystems, Inc.
0N/A */
0N/Apackage org.opends.server.core;
0N/A
4899N/Aimport java.util.Set;
4899N/A
4134N/Aimport org.opends.server.types.*;
0N/A
0N/A
0N/A/**
1842N/A * This interface defines an operation that may be used to determine whether a
0N/A * specified entry in the Directory Server contains a given attribute-value
0N/A * pair.
0N/A */
1842N/Apublic interface CompareOperation extends Operation
0N/A{
1400N/A /**
0N/A * Retrieves the raw, unprocessed entry DN as included in the client request.
0N/A * The DN that is returned may or may not be a valid DN, since no validation
0N/A * will have been performed upon it.
0N/A *
0N/A * @return The raw, unprocessed entry DN as included in the client request.
0N/A */
1842N/A public ByteString getRawEntryDN();
0N/A
0N/A
0N/A /**
0N/A * Specifies the raw, unprocessed entry DN as included in the client request.
338N/A * This should only be called by pre-parse plugins.
0N/A *
0N/A * @param rawEntryDN The raw, unprocessed entry DN as included in the client
0N/A * request.
0N/A */
1842N/A public void setRawEntryDN(ByteString rawEntryDN);
0N/A
0N/A
0N/A /**
0N/A * Retrieves the DN of the entry to compare. This should not be called by
0N/A * pre-parse plugins because the processed DN will not be available yet.
0N/A * Instead, they should call the <CODE>getRawEntryDN</CODE> method.
0N/A *
0N/A * @return The DN of the entry to compare, or <CODE>null</CODE> if the raw
0N/A * entry DN has not yet been processed.
0N/A */
1842N/A public DN getEntryDN();
0N/A
0N/A
0N/A /**
0N/A * Retrieves the raw attribute type for this compare operation.
0N/A *
0N/A * @return The raw attribute type for this compare operation.
0N/A */
1842N/A public String getRawAttributeType();
0N/A
0N/A
0N/A /**
0N/A * Specifies the raw attribute type for this compare operation. This should
0N/A * only be called by pre-parse plugins.
0N/A *
0N/A * @param rawAttributeType The raw attribute type for this compare
0N/A * operation.
0N/A */
1842N/A public void setRawAttributeType(String rawAttributeType);
0N/A
0N/A
0N/A /**
338N/A * Retrieves the attribute type for this compare operation. This should not
338N/A * be called by pre-parse plugins because the processed attribute type will
338N/A * not be available yet.
0N/A *
0N/A * @return The attribute type for this compare operation.
0N/A */
1842N/A public AttributeType getAttributeType();
1842N/A
0N/A
1842N/A /**
1842N/A * Specifies the attribute type for this compare operation.
1842N/A *
1842N/A * @param attributeType The attribute type for this compare operation.
1842N/A */
1842N/A public void setAttributeType(AttributeType attributeType);
0N/A
0N/A
0N/A /**
4899N/A * Retrieves the attribute options for this compare operation. This should
4899N/A * not be called by the pre-parse plugins because the processed attribute
4899N/A * options will not be available yet.
4899N/A *
4899N/A * @return The attribute options for this compare operation.
4899N/A */
4899N/A public Set<String> getAttributeOptions();
4899N/A
4899N/A /**
4899N/A * Specifies the attribute options for this compare operation.
4899N/A *
4899N/A * @param attributeOptions The attribute options for this compare operation.
4899N/A */
4899N/A public void setAttributeOptions(Set<String> attributeOptions);
4899N/A
4899N/A /**
0N/A * Retrieves the assertion value for this compare operation.
0N/A *
0N/A * @return The assertion value for this compare operation.
0N/A */
1842N/A public ByteString getAssertionValue();
0N/A
0N/A
0N/A /**
338N/A * Specifies the assertion value for this compare operation. This should only
338N/A * be called by pre-parse and pre-operation plugins.
0N/A *
0N/A * @param assertionValue The assertion value for this compare operation.
0N/A */
1842N/A public void setAssertionValue(ByteString assertionValue);
338N/A
338N/A
338N/A /**
1842N/A * Retrieves the proxied authorization target DN for this compare operation.
1842N/A *
1842N/A * @return The proxied authorization target DN for this compare operation
338N/A */
1842N/A public DN getProxiedAuthorizationDN();
0N/A
0N/A
0N/A /**
1842N/A * Specifies the proxied authorization target DN for this compare operation.
1842N/A *
1842N/A * @param proxiedAuthorizationDN The proxied authorization target DN for
1842N/A * this compare operation
0N/A */
1842N/A public void setProxiedAuthorizationDN(DN proxiedAuthorizationDN);
1689N/A
0N/A}