001/*
002 * Copyright 2011-2023 Ping Identity Corporation
003 * All Rights Reserved.
004 */
005/*
006 * Copyright 2011-2023 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) 2011-2023 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 java.io.Serializable;
041
042import com.unboundid.util.InternalUseOnly;
043import com.unboundid.util.Mutable;
044import com.unboundid.util.NotNull;
045import com.unboundid.util.Nullable;
046import com.unboundid.util.ThreadSafety;
047import com.unboundid.util.ThreadSafetyLevel;
048
049
050
051/**
052 * This class provides a basic implementation of the {@link AsyncResultListener}
053 * interface that will merely set the result object to a local variable that can
054 * be accessed through a getter method.  It provides a listener that may be
055 * easily used when processing an asynchronous operation using the
056 * {@link AsyncRequestID} as a {@code java.util.concurrent.Future} object.
057 */
058@Mutable()
059@ThreadSafety(level=ThreadSafetyLevel.NOT_THREADSAFE)
060public final class BasicAsyncResultListener
061       implements AsyncResultListener, Serializable
062{
063  /**
064   * The serial version UID for this serializable class.
065   */
066  private static final long serialVersionUID = -2701328904233458257L;
067
068
069
070  // The result that has been received for the associated operation.
071  @Nullable private volatile LDAPResult ldapResult;
072
073
074
075  /**
076   * Creates a new instance of this class for use in processing a single add,
077   * delete, modify, or modify DN operation.  A single basic async result
078   * listener object may not be used for multiple operations.
079   */
080  public BasicAsyncResultListener()
081  {
082    ldapResult = null;
083  }
084
085
086
087  /**
088   * {@inheritDoc}
089   */
090  @InternalUseOnly()
091  @Override()
092  public void ldapResultReceived(@NotNull final AsyncRequestID requestID,
093                                 @NotNull final LDAPResult ldapResult)
094  {
095    this.ldapResult = ldapResult;
096  }
097
098
099
100  /**
101   * Retrieves the result that has been received for the associated asynchronous
102   * operation, if it has been received.
103   *
104   * @return  The result that has been received for the associated asynchronous
105   *          operation, or {@code null} if no response has been received yet.
106   */
107  @Nullable()
108  public LDAPResult getLDAPResult()
109  {
110    return ldapResult;
111  }
112}