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