001 /* 002 * Copyright 2007-2015 UnboundID Corp. 003 * All Rights Reserved. 004 */ 005 /* 006 * Copyright (C) 2008-2015 UnboundID Corp. 007 * 008 * This program is free software; you can redistribute it and/or modify 009 * it under the terms of the GNU General Public License (GPLv2 only) 010 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only) 011 * as published by the Free Software Foundation. 012 * 013 * This program is distributed in the hope that it will be useful, 014 * but WITHOUT ANY WARRANTY; without even the implied warranty of 015 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 016 * GNU General Public License for more details. 017 * 018 * You should have received a copy of the GNU General Public License 019 * along with this program; if not, see <http://www.gnu.org/licenses>. 020 */ 021 package com.unboundid.ldap.sdk; 022 023 024 025 import com.unboundid.asn1.ASN1OctetString; 026 027 028 029 /** 030 * This interface defines a set of methods that may be safely called in an LDAP 031 * compare request without altering its contents. This interface must not be 032 * implemented by any class other than {@code CompareRequest}. 033 * <BR><BR> 034 * This interface does not inherently provide the assurance of thread safety for 035 * the methods that it exposes, because it is still possible for a thread 036 * referencing the object which implements this interface to alter the request 037 * using methods not included in this interface. However, if it can be 038 * guaranteed that no thread will alter the underlying object, then the methods 039 * exposed by this interface can be safely invoked concurrently by any number of 040 * threads. 041 */ 042 public interface ReadOnlyCompareRequest 043 extends ReadOnlyLDAPRequest 044 { 045 /** 046 * Retrieves the DN of the entry in which the comparison is to be performed. 047 * 048 * @return The DN of the entry in which the comparison is to be performed. 049 */ 050 String getDN(); 051 052 053 054 /** 055 * Retrieves the name of the attribute for which the comparison is to be 056 * performed. 057 * 058 * @return The name of the attribute for which the comparison is to be 059 * performed. 060 */ 061 String getAttributeName(); 062 063 064 065 /** 066 * Retrieves the assertion value to verify within the target entry. 067 * 068 * @return The assertion value to verify within the target entry. 069 */ 070 String getAssertionValue(); 071 072 073 074 /** 075 * Retrieves the assertion value to verify within the target entry, formatted 076 * as a byte array. 077 * 078 * @return The assertion value to verify within the target entry, formatted 079 * as a byte array. 080 */ 081 byte[] getAssertionValueBytes(); 082 083 084 085 /** 086 * Retrieves the assertion value to verify within the target entry. 087 * 088 * @return The assertion value to verify within the target entry. 089 */ 090 ASN1OctetString getRawAssertionValue(); 091 092 093 094 /** 095 * {@inheritDoc} 096 */ 097 CompareRequest duplicate(); 098 099 100 101 /** 102 * {@inheritDoc} 103 */ 104 CompareRequest duplicate(final Control[] controls); 105 }