001    /*
002     * Copyright 2007-2014 UnboundID Corp.
003     * All Rights Reserved.
004     */
005    /*
006     * Copyright (C) 2008-2014 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    import com.unboundid.util.NotExtensible;
027    import com.unboundid.util.ThreadSafety;
028    import com.unboundid.util.ThreadSafetyLevel;
029    
030    
031    
032    /**
033     * This interface defines a set of methods that may be safely called in an LDAP
034     * compare request without altering its contents.  This interface must not be
035     * implemented by any class other than {@link CompareRequest}.
036     * <BR><BR>
037     * This interface does not inherently provide the assurance of thread safety for
038     * the methods that it exposes, because it is still possible for a thread
039     * referencing the object which implements this interface to alter the request
040     * using methods not included in this interface.  However, if it can be
041     * guaranteed that no thread will alter the underlying object, then the methods
042     * exposed by this interface can be safely invoked concurrently by any number of
043     * threads.
044     */
045    @NotExtensible()
046    @ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
047    public interface ReadOnlyCompareRequest
048           extends ReadOnlyLDAPRequest
049    {
050      /**
051       * Retrieves the DN of the entry in which the comparison is to be performed.
052       *
053       * @return  The DN of the entry in which the comparison is to be performed.
054       */
055      String getDN();
056    
057    
058    
059      /**
060       * Retrieves the name of the attribute for which the comparison is to be
061       * performed.
062       *
063       * @return  The name of the attribute for which the comparison is to be
064       *          performed.
065       */
066      String getAttributeName();
067    
068    
069    
070      /**
071       * Retrieves the assertion value to verify within the target entry.
072       *
073       * @return  The assertion value to verify within the target entry.
074       */
075      String getAssertionValue();
076    
077    
078    
079      /**
080       * Retrieves the assertion value to verify within the target entry, formatted
081       * as a byte array.
082       *
083       * @return  The assertion value to verify within the target entry, formatted
084       *          as a byte array.
085       */
086      byte[] getAssertionValueBytes();
087    
088    
089    
090      /**
091       * Retrieves the assertion value to verify within the target entry.
092       *
093       * @return  The assertion value to verify within the target entry.
094       */
095      ASN1OctetString getRawAssertionValue();
096    
097    
098    
099      /**
100       * {@inheritDoc}
101       */
102      CompareRequest duplicate();
103    
104    
105    
106      /**
107       * {@inheritDoc}
108       */
109      CompareRequest duplicate(final Control[] controls);
110    }