|
|
Author: elecharny
Date: Sat Apr 11 07:15:11 2009
New Revision: 764178
URL: http://svn.apache.org/viewvc?rev=764178&view=rev
Log:
Added a SearchFuture class
Added:
directory/shared/trunk/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/future/SearchFuture.java
Added:
directory/shared/trunk/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/future/SearchFuture.java
URL:
http://svn.apache.org/viewvc/directory/shared/trunk/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/future/SearchFuture.java?rev=764178&view=auto
==============================================================================
---
directory/shared/trunk/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/future/SearchFuture.java
(added)
+++
directory/shared/trunk/client-api/src/main/java/org/apache/directory/shared/ldap/client/api/messages/future/SearchFuture.java
Sat Apr 11 07:15:11 2009
@@ -0,0 +1,107 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ */
+package org.apache.directory.shared.ldap.client.api.messages.future;
+
+import java.util.concurrent.BlockingQueue;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.Future;
+import java.util.concurrent.TimeUnit;
+import java.util.concurrent.TimeoutException;
+
+import org.apache.directory.shared.ldap.client.api.messages.SearchResponse;
+
+/**
+ * A Future to manage SerachRequest
+ *
+ * @author <a href="mailto:dev@xxxxxxxxxxxxxxxxxxxx";>Apache Directory
Project</a>
+ * @version $Rev$, $Date$
+ */
+public class SearchFuture implements Future<SearchResponse>
+{
+ /** The queue where SearchResponse are stored */
+ private BlockingQueue<SearchResponse> searchResponseQueue;
+
+
+ /**
+ *
+ * Creates a new instance of SearchFuture.
+ *
+ * @param searchResponseQueue The associated SearchResponse queue
+ */
+ public SearchFuture( BlockingQueue<SearchResponse> searchResponseQueue )
+ {
+ this.searchResponseQueue = searchResponseQueue;
+ }
+
+
+ /**
+ * {@inheritDoc}
+ */
+ public boolean cancel( boolean mayInterruptIfRunning )
+ {
+ throw new RuntimeException( "Not Yet Implemented" );
+ }
+
+
+ /**
+ * Get the SearchResponse, blocking until one is received.
+ * It can be either a SearchResultEntry, a SearchResultReference
+ * or a SearchResultDone, the last of all the SearchResponse.
+ *
+ * @return The SearchResponse
+ */
+ public SearchResponse get() throws InterruptedException, ExecutionException
+ {
+ return searchResponseQueue.poll();
+ }
+
+
+ /**
+ * Get the SearchResponse, blocking until one is received, or until the
+ * given timeout is reached.
+ *
+ * @param timeout Number of TimeUnit to wait
+ * @param unit The TimeUnit
+ * @return The SearchResponse The SearchResponse found
+ */
+ public SearchResponse get( long timeout, TimeUnit unit ) throws
InterruptedException, ExecutionException,
+ TimeoutException
+ {
+ return searchResponseQueue.poll( timeout, unit );
+ }
+
+
+ /**
+ * {@inheritDoc}
+ */
+ public boolean isCancelled()
+ {
+ throw new RuntimeException( "Not Yet Implemented" );
+ }
+
+
+ /**
+ * {@inheritDoc}
+ */
+ public boolean isDone()
+ {
+ throw new RuntimeException( "Not Yet Implemented" );
+ }
+}
|
|