001/*
002 * Copyright 2007-2022 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2007-2022 Ping Identity Corporation
007 *
008 * Licensed under the Apache License, Version 2.0 (the "License");
009 * you may not use this file except in compliance with the License.
010 * You may obtain a copy of the License at
011 *
012 *    http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing, software
015 * distributed under the License is distributed on an "AS IS" BASIS,
016 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
017 * See the License for the specific language governing permissions and
018 * limitations under the License.
019 */
020/*
021 * Copyright (C) 2007-2022 Ping Identity Corporation
022 *
023 * This program is free software; you can redistribute it and/or modify
024 * it under the terms of the GNU General Public License (GPLv2 only)
025 * or the terms of the GNU Lesser General Public License (LGPLv2.1 only)
026 * as published by the Free Software Foundation.
027 *
028 * This program is distributed in the hope that it will be useful,
029 * but WITHOUT ANY WARRANTY; without even the implied warranty of
030 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
031 * GNU General Public License for more details.
032 *
033 * You should have received a copy of the GNU General Public License
034 * along with this program; if not, see <http://www.gnu.org/licenses>.
035 */
036package com.unboundid.ldap.sdk;
037
038
039
040import com.unboundid.asn1.ASN1OctetString;
041import com.unboundid.util.NotExtensible;
042import com.unboundid.util.NotNull;
043import com.unboundid.util.Nullable;
044import com.unboundid.util.ThreadSafety;
045import com.unboundid.util.ThreadSafetyLevel;
046
047
048
049/**
050 * This interface defines a set of methods that may be safely called in an LDAP
051 * compare request without altering its contents.  This interface must not be
052 * implemented by any class other than {@link CompareRequest}.
053 * <BR><BR>
054 * This interface does not inherently provide the assurance of thread safety for
055 * the methods that it exposes, because it is still possible for a thread
056 * referencing the object which implements this interface to alter the request
057 * using methods not included in this interface.  However, if it can be
058 * guaranteed that no thread will alter the underlying object, then the methods
059 * exposed by this interface can be safely invoked concurrently by any number of
060 * threads.
061 */
062@NotExtensible()
063@ThreadSafety(level=ThreadSafetyLevel.INTERFACE_NOT_THREADSAFE)
064public interface ReadOnlyCompareRequest
065       extends ReadOnlyLDAPRequest
066{
067  /**
068   * Retrieves the DN of the entry in which the comparison is to be performed.
069   *
070   * @return  The DN of the entry in which the comparison is to be performed.
071   */
072  @NotNull()
073  String getDN();
074
075
076
077  /**
078   * Retrieves the name of the attribute for which the comparison is to be
079   * performed.
080   *
081   * @return  The name of the attribute for which the comparison is to be
082   *          performed.
083   */
084  @NotNull()
085  String getAttributeName();
086
087
088
089  /**
090   * Retrieves the assertion value to verify within the target entry.
091   *
092   * @return  The assertion value to verify within the target entry.
093   */
094  @NotNull()
095  String getAssertionValue();
096
097
098
099  /**
100   * Retrieves the assertion value to verify within the target entry, formatted
101   * as a byte array.
102   *
103   * @return  The assertion value to verify within the target entry, formatted
104   *          as a byte array.
105   */
106  @NotNull()
107  byte[] getAssertionValueBytes();
108
109
110
111  /**
112   * Retrieves the assertion value to verify within the target entry.
113   *
114   * @return  The assertion value to verify within the target entry.
115   */
116  @NotNull()
117  ASN1OctetString getRawAssertionValue();
118
119
120
121  /**
122   * {@inheritDoc}
123   */
124  @Override()
125  @NotNull()
126  CompareRequest duplicate();
127
128
129
130  /**
131   * {@inheritDoc}
132   */
133  @Override()
134  @NotNull()
135  CompareRequest duplicate(@Nullable Control[] controls);
136}