001/* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at legal-notices/CDDLv1_0.txt 010 * or http://forgerock.org/license/CDDLv1.0.html. 011 * See the License for the specific language governing permissions 012 * and limitations under the License. 013 * 014 * When distributing Covered Code, include this CDDL HEADER in each 015 * file and include the License file at legal-notices/CDDLv1_0.txt. 016 * If applicable, add the following below this CDDL HEADER, with the 017 * fields enclosed by brackets "[]" replaced with your own identifying 018 * information: 019 * Portions Copyright [yyyy] [name of copyright owner] 020 * 021 * CDDL HEADER END 022 * 023 * 024 * Copyright 2006-2008 Sun Microsystems, Inc. 025 * Portions Copyright 2014-2015 ForgeRock AS 026 */ 027package org.opends.server.types.operation; 028 029 030 031import org.opends.server.types.AttributeType; 032import org.forgerock.opendj.ldap.ByteString; 033import org.opends.server.types.DN; 034import org.opends.server.types.Entry; 035 036 037 038/** 039 * This class defines a set of methods that are available for use by 040 * pre-operation plugins for compare operations. Note that this 041 * interface is intended only to define an API for use by plugins and 042 * is not intended to be implemented by any custom classes. 043 */ 044@org.opends.server.types.PublicAPI( 045 stability=org.opends.server.types.StabilityLevel.UNCOMMITTED, 046 mayInstantiate=false, 047 mayExtend=false, 048 mayInvoke=true) 049public interface PreOperationCompareOperation 050 extends PreOperationOperation 051{ 052 /** 053 * Retrieves the raw, unprocessed entry DN as included in the client 054 * request. 055 * 056 * @return The raw, unprocessed entry DN as included in the client 057 * request. 058 */ 059 ByteString getRawEntryDN(); 060 061 062 063 /** 064 * Retrieves the DN of the entry to compare. 065 * 066 * @return The DN of the entry to compare. 067 */ 068 DN getEntryDN(); 069 070 071 072 /** 073 * Retrieves the raw attribute type for this compare operation. 074 * 075 * @return The raw attribute type for this compare operation. 076 */ 077 String getRawAttributeType(); 078 079 080 081 /** 082 * Retrieves the attribute type for this compare operation. 083 * 084 * @return The attribute type for this compare operation. 085 */ 086 AttributeType getAttributeType(); 087 088 089 090 /** 091 * Retrieves the assertion value for this compare operation. 092 * 093 * @return The assertion value for this compare operation. 094 */ 095 ByteString getAssertionValue(); 096 097 098 099 /** 100 * Specifies the assertion value for this compare operation. 101 * 102 * @param assertionValue The assertion value for this compare 103 * operation. 104 */ 105 void setAssertionValue(ByteString assertionValue); 106 107 108 109 /** 110 * Retrieves the entry to target with the compare operation. 111 * 112 * @return The entry to target with the compare operation. 113 */ 114 Entry getEntryToCompare(); 115} 116