diff options
| author | rescobar | 2011-08-10 01:43:56 +0000 |
|---|---|---|
| committer | Ryan D. Brooks | 2011-08-10 01:43:56 +0000 |
| commit | 129a02c8e0d7c0bdd1c461d8ecb1e2df81d8141f (patch) | |
| tree | a4c70b97dc8c1dd23902b19e9c96f26f52139a87 | |
| parent | 53becd4f4abb1a45038ce2b2509af10312876014 (diff) | |
| download | org.eclipse.osee-129a02c8e0d7c0bdd1c461d8ecb1e2df81d8141f.tar.gz org.eclipse.osee-129a02c8e0d7c0bdd1c461d8ecb1e2df81d8141f.tar.xz org.eclipse.osee-129a02c8e0d7c0bdd1c461d8ecb1e2df81d8141f.zip | |
feature: Add distributed collections
19 files changed, 939 insertions, 0 deletions
diff --git a/plugins/org.eclipse.osee.distributed/.classpath b/plugins/org.eclipse.osee.distributed/.classpath new file mode 100644 index 00000000000..ad32c83a788 --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/.classpath @@ -0,0 +1,7 @@ +<?xml version="1.0" encoding="UTF-8"?> +<classpath> + <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/> + <classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/> + <classpathentry kind="src" path="src"/> + <classpathentry kind="output" path="bin"/> +</classpath> diff --git a/plugins/org.eclipse.osee.distributed/.project b/plugins/org.eclipse.osee.distributed/.project new file mode 100644 index 00000000000..f23905d667c --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/.project @@ -0,0 +1,28 @@ +<?xml version="1.0" encoding="UTF-8"?> +<projectDescription> + <name>org.eclipse.osee.distributed</name> + <comment></comment> + <projects> + </projects> + <buildSpec> + <buildCommand> + <name>org.eclipse.jdt.core.javabuilder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.pde.ManifestBuilder</name> + <arguments> + </arguments> + </buildCommand> + <buildCommand> + <name>org.eclipse.pde.SchemaBuilder</name> + <arguments> + </arguments> + </buildCommand> + </buildSpec> + <natures> + <nature>org.eclipse.pde.PluginNature</nature> + <nature>org.eclipse.jdt.core.javanature</nature> + </natures> +</projectDescription> diff --git a/plugins/org.eclipse.osee.distributed/META-INF/MANIFEST.MF b/plugins/org.eclipse.osee.distributed/META-INF/MANIFEST.MF new file mode 100644 index 00000000000..14b3ec90036 --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/META-INF/MANIFEST.MF @@ -0,0 +1,8 @@ +Manifest-Version: 1.0 +Bundle-ManifestVersion: 2 +Bundle-Name: Osee Distributed +Bundle-SymbolicName: org.eclipse.osee.distributed +Bundle-Version: 0.9.9.qualifier +Bundle-Vendor: Open System Engineering Environment +Bundle-RequiredExecutionEnvironment: JavaSE-1.6 +Export-Package: org.eclipse.osee.distributed diff --git a/plugins/org.eclipse.osee.distributed/build.properties b/plugins/org.eclipse.osee.distributed/build.properties new file mode 100644 index 00000000000..34d2e4d2dad --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/build.properties @@ -0,0 +1,4 @@ +source.. = src/ +output.. = bin/ +bin.includes = META-INF/,\ + . diff --git a/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/AtomicNumber.java b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/AtomicNumber.java new file mode 100644 index 00000000000..60e91776d75 --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/AtomicNumber.java @@ -0,0 +1,38 @@ +/******************************************************************************* + * Copyright (c) 2004, 2007 Boeing. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Boeing - initial API and implementation + *******************************************************************************/ +package org.eclipse.osee.distributed; + + +/** + * @author Roberto E. Escobar + */ +public interface AtomicNumber extends DistributedObject, HasName { + + long get(); + + void set(long newValue); + + long decrementAndGet(); + + long incrementAndGet(); + + long getAndAdd(long delta); + + long addAndGet(long delta); + + long getAndSet(long newValue); + + void lazySet(long newValue); + + boolean compareAndSet(long expect, long update); + + boolean weakCompareAndSet(long expect, long update); +}
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/Disposeable.java b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/Disposeable.java new file mode 100644 index 00000000000..fcc742c012a --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/Disposeable.java @@ -0,0 +1,19 @@ +/******************************************************************************* + * Copyright (c) 2004, 2007 Boeing. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Boeing - initial API and implementation + *******************************************************************************/ +package org.eclipse.osee.distributed; + +/** + * @author Roberto E. Escobar + */ +public interface Disposeable { + + void dispose(); +} diff --git a/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedBlockingQueue.java b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedBlockingQueue.java new file mode 100644 index 00000000000..4beb3811909 --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedBlockingQueue.java @@ -0,0 +1,20 @@ +/******************************************************************************* + * Copyright (c) 2004, 2007 Boeing. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Boeing - initial API and implementation + *******************************************************************************/ +package org.eclipse.osee.distributed; + +import java.util.concurrent.BlockingQueue; + +/** + * @author Roberto E. Escobar + */ +public interface DistributedBlockingQueue<E> extends BlockingQueue<E>, DistributedCollection { + // +} diff --git a/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedCollection.java b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedCollection.java new file mode 100644 index 00000000000..dcd8db0ec27 --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedCollection.java @@ -0,0 +1,18 @@ +/******************************************************************************* + * Copyright (c) 2004, 2007 Boeing. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Boeing - initial API and implementation + *******************************************************************************/ +package org.eclipse.osee.distributed; + +/** + * @author Roberto E. Escobar + */ +public interface DistributedCollection extends DistributedObject, HasName { + // +} diff --git a/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedId.java b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedId.java new file mode 100644 index 00000000000..b2b0066f5a3 --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedId.java @@ -0,0 +1,21 @@ +/******************************************************************************* + * Copyright (c) 2004, 2007 Boeing. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Boeing - initial API and implementation + *******************************************************************************/ +package org.eclipse.osee.distributed; + + +/** + * @author Roberto E. Escobar + */ +public interface DistributedId extends DistributedObject, HasName { + + long newId(); + +}
\ No newline at end of file diff --git a/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedList.java b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedList.java new file mode 100644 index 00000000000..39b01de5b25 --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedList.java @@ -0,0 +1,20 @@ +/******************************************************************************* + * Copyright (c) 2004, 2007 Boeing. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Boeing - initial API and implementation + *******************************************************************************/ +package org.eclipse.osee.distributed; + +import java.util.List; + +/** + * @author Roberto E. Escobar + */ +public interface DistributedList<E> extends List<E>, DistributedCollection { + // +} diff --git a/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedLock.java b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedLock.java new file mode 100644 index 00000000000..1155d1b261a --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedLock.java @@ -0,0 +1,22 @@ +/******************************************************************************* + * Copyright (c) 2004, 2007 Boeing. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Boeing - initial API and implementation + *******************************************************************************/ +package org.eclipse.osee.distributed; + +import java.util.concurrent.locks.Lock; + +/** + * @author Roberto E. Escobar + */ +public interface DistributedLock extends Lock, DistributedObject { + + Object getObjectLocked(); + +} diff --git a/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedMap.java b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedMap.java new file mode 100644 index 00000000000..c1f3c668b66 --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedMap.java @@ -0,0 +1,399 @@ +/******************************************************************************* + * Copyright (c) 2004, 2007 Boeing. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Boeing - initial API and implementation + *******************************************************************************/ +package org.eclipse.osee.distributed; + +import java.util.Collection; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.ConcurrentMap; +import java.util.concurrent.Future; +import java.util.concurrent.TimeUnit; +import java.util.concurrent.TimeoutException; + +/** + * @author Roberto E. Escobar + */ +public interface DistributedMap<K, V> extends ConcurrentMap<K, V>, DistributedCollection { + + /** + * If this map has a MapStore and write-delay-seconds is bigger than 0 (write-behind) then this method flushes all + * the local dirty entries by calling MapStore.storeAll() + */ + void flush(); + + /** + * Returns the entries for the given keys. + * + * @param keys keys to get + * @return map of entries + */ + Map<K, V> getAll(Set<K> keys); + + /** + * Asynchronously gets the given key. <code> + * Future future = map.getAsync(key); + * // do some other stuff, when ready get the result + * Object value = future.get(); + * </code> Future.get() will block until the actual map.get() completes. If the application requires timely response, + * then Future.get(timeout, timeunit) can be used. <code> + * try{ + * Future future = map.getAsync(key); + * Object value = future.get(40, TimeUnit.MILLISECOND); + * }catch (TimeoutException t) { + * // time wasn't enough + * } + * </code> ExecutionException is never thrown. + * + * @param key the key of the map entry + * @return Future from which the value of the key can be retrieved. + * @see java.util.concurrent.Future + */ + Future<V> getAsync(K key); + + /** + * Asynchronously puts the given key and value. <code> + * Future future = map.putAsync(key, value); + * // do some other stuff, when ready get the result + * Object oldValue = future.get(); + * </code> Future.get() will block until the actual map.get() completes. If the application requires timely response, + * then Future.get(timeout, timeunit) can be used. <code> + * try{ + * Future future = map.putAsync(key, newValue); + * Object oldValue = future.get(40, TimeUnit.MILLISECOND); + * }catch (TimeoutException t) { + * // time wasn't enough + * } + * </code> ExecutionException is never thrown. + * + * @param key the key of the map entry + * @param value the new value of the map entry + * @return Future from which the old value of the key can be retrieved. + * @see java.util.concurrent.Future + */ + Future<V> putAsync(K key, V value); + + /** + * Asynchronously removes the given key. + * + * @param key The key of the map entry to remove. + * @return A {@link java.util.concurrent.Future} from which the value removed from the map can be retrieved. + */ + Future<V> removeAsync(K key); + + /** + * Tries to remove the entry with the given key from this map within specified timeout value. If the key is already + * locked by another thread and/or member, then this operation will wait timeout amount for acquiring the lock. + * + * @param key key of the entry + * @param timeout maximum time to wait for acquiring the lock for the key + * @param timeunit time unit for the timeout + * @return removed value of the entry + * @throws java.util.concurrent.TimeoutException if lock cannot be acquired for the given key within timeout + */ + Object tryRemove(K key, long timeout, TimeUnit timeunit) throws TimeoutException; + + /** + * Tries to put the given key, value into this map within specified timeout value. If this method returns false, it + * means that the caller thread couldn't acquire the lock for the key within timeout duration, thus put operation is + * not successful. + * + * @param key key of the entry + * @param value value of the entry + * @param timeout maximum time to wait + * @param timeunit time unit for the timeout + * @return <tt>true</tt> if the put is successful, <tt>false</tt> otherwise. + */ + boolean tryPut(K key, V value, long timeout, TimeUnit timeunit); + + /** + * Puts an entry into this map with a given ttl (time to live) value. Entry will expire and get evicted after the + * ttl. + * + * @param key key of the entry + * @param value value of the entry + * @param ttl maximum time for this entry to stay in the map + * @param timeunit time unit for the ttl + * @return old value of the entry + */ + V put(K key, V value, long ttl, TimeUnit timeunit); + + /** + * Same as {@link #put(K, V, long, TimeUnit)} but MapStore, if defined, will not be called to store/persist the + * entry. + * + * @param key key of the entry + * @param value value of the entry + * @param ttl maximum time for this entry to stay in the map + * @param timeunit time unit for the ttl + * @return old value of the entry + */ + void putTransient(K key, V value, long ttl, TimeUnit timeunit); + + /** + * Puts an entry into this map with a given ttl (time to live) value if the specified key is not already associated + * with a value. Entry will expire and get evicted after the ttl. + * + * @param key key of the entry + * @param value value of the entry + * @param ttl maximum time for this entry to stay in the map + * @param timeunit time unit for the ttl + * @return old value of the entry + */ + V putIfAbsent(K key, V value, long ttl, TimeUnit timeunit); + + /** + * Tries to acquire the lock for the specified key and returns the value of the key if lock is required in time. + * <p> + * If the lock is not available then the current thread becomes disabled for thread scheduling purposes and lies + * dormant until one of two things happens: + * <ul> + * <li>The lock is acquired by the current thread; or + * <li>The specified waiting time elapses + * </ul> + * + * @param key key of the entry + * @param time maximum time to wait for the lock + * @param timeunit time unit of the <tt>time</tt> argument. + * @return value of the key in this map + * @throws java.util.concurrent.TimeoutException if lock cannot be acquired in time. + */ + V tryLockAndGet(K key, long time, TimeUnit timeunit) throws TimeoutException; + + /** + * Puts the key and value into this map and unlocks the key if the calling thread owns the lock. + * + * @param key key of the entry + * @param value value of the entry + */ + void putAndUnlock(K key, V value); + + /** + * Acquires the lock for the specified key. + * <p> + * If the lock is not available then the current thread becomes disabled for thread scheduling purposes and lies + * dormant until the lock has been acquired. + * <p/> + * Scope of the lock is this map only. Acquired lock is only for the key in this map. + * <p/> + * Locks are re-entrant so if the key is locked N times then it should be unlocked N times before another thread can + * acquire it. + * + * @param key key to lock. + */ + void lock(K key); + + /** + * Tries to acquire the lock for the specified key. + * <p> + * If the lock is not available then the current thread doesn't wait and returns false immediately. + * + * @param key key to lock. + * @return <tt>true</tt> if lock is acquired, <tt>false</tt> otherwise. + */ + boolean tryLock(K key); + + /** + * Tries to acquire the lock for the specified key. + * <p> + * If the lock is not available then the current thread becomes disabled for thread scheduling purposes and lies + * dormant until one of two things happens: + * <ul> + * <li>The lock is acquired by the current thread; or + * <li>The specified waiting time elapses + * </ul> + * + * @param key key to lock in this map + * @param time maximum time to wait for the lock + * @param timeunit time unit of the <tt>time</tt> argument. + * @return <tt>true</tt> if the lock was acquired and <tt>false</tt> if the waiting time elapsed before the lock was + * acquired. + */ + boolean tryLock(K key, long time, TimeUnit timeunit); + + /** + * Releases the lock for the specified key. It never blocks and returns immediately. + * + * @param key key to lock. + */ + void unlock(K key); + + /** + * Tries to acquire the lock for the entire map. The thread that locks the map can do all the operations but other + * threads in the cluster cannot operate on the map. + * <p> + * If the lock is not available then the current thread becomes disabled for thread scheduling purposes and lies + * dormant until one of two things happens: + * <ul> + * <li>The lock is acquired by the current thread; or + * <li>The specified waiting time elapses + * </ul> + * + * @param time maximum time to wait for the lock + * @param timeunit time unit of the <tt>time</tt> argument. + * @return <tt>true</tt> if the lock was acquired and <tt>false</tt> if the waiting time elapsed before the lock was + * acquired. + */ + boolean lockMap(long time, TimeUnit timeunit); + + /** + * Unlocks the map. It never blocks and returns immediately. + */ + void unlockMap(); + + /** + * Returns the <tt>Map.Entry</tt> for the specified key. + * + * @param key key of the entry + * @return <tt>MapEntry</tt> of the specified key + * @see MapEntry + */ + Map.Entry<K, V> getMapEntry(K key); + + /** + * Evicts the specified key from this map. If a <tt>MapStore</tt> defined for this map, then the entry is not deleted + * from the underlying <tt>MapStore</tt>, evict only removes the entry from the memory. + * + * @param key key to evict + * @return <tt>true</tt> if the key is evicted, <tt>false</tt> otherwise. + */ + boolean evict(Object key); + + /** + * Queries the map based on the specified predicate and returns the keys of matching entries. + * <p/> + * Specified predicate runs on all members in parallel. + * + * @param predicate query criteria + * @return result key set of the query + */ + Set<K> keySet(Predicate<K, V> predicate); + + /** + * Queries the map based on the specified predicate and returns the matching entries. + * <p/> + * Specified predicate runs on all members in parallel. + * + * @param predicate query criteria + * @return result entry set of the query + */ + Set<Map.Entry<K, V>> entrySet(Predicate<K, V> predicate); + + /** + * Queries the map based on the specified predicate and returns the values of matching entries. + * <p/> + * Specified predicate runs on all members in parallel. + * + * @param predicate query criteria + * @return result value collection of the query + */ + Collection<V> values(Predicate<K, V> predicate); + + // /** + // * Adds an index to this map for the specified entries so that queries can run faster. + // * <p/> + // * Let's say your map values are Employee objects. + // * + // * <pre> + // * public class Employee implements Serializable { + // * private boolean active = false; + // * private int age; + // * private String name = null; + // * // other fields. + // * + // * // getters setter + // * + // * } + // * </pre> + // * <p/> + // * If you are querying your values mostly based on age and active then you should consider indexing these fields. + // * + // * <pre> + // * IMap imap = Hazelcast.getMap("employees"); + // * imap.addIndex("age", true); // ordered, since we have ranged queries for this field + // * imap.addIndex("active", false); // not ordered, because boolean field cannot have range + // * </pre> + // * <p/> + // * Index attribute should either have a getter method or be public. You should also make sure to add the indexes + // * before adding entries to this map. + // * + // * @param attribute attribute of value + // * @param ordered <tt>true</tt> if index should be ordered, <tt>false</tt> otherwise. + // */ + // void addIndex(String attribute, boolean ordered); + // + // /** + // * Adds an index to this map based on the provided expression. + // * + // * @param expression expression for the index. + // * @param ordered <tt>true</tt> if index should be ordered, <tt>false</tt> otherwise. + // */ + // void addIndex(Expression<?> expression, boolean ordered); + // /** + // * Returns LocalMapStats for this map. LocalMapStats is the statistics for the local portion of this distributed map + // * and contains information such as ownedEntryCount backupEntryCount, lastUpdateTime, lockedEntryCount. + // * <p/> + // * Since this stats are only for the local portion of this map, if you need the cluster-wide MapStats then you need + // * to get the LocalMapStats from all members of the cluster and combine them. + // * + // * @return this map's local statistics. + // */ + // LocalMapStats getLocalMapStats(); + + // /** + // * Adds a local entry listener for this map. Added listener will be only listening for the events + // * (add/remove/update/evict) of the locally owned entries. + // * <p/> + // * Note that entries in distributed map are partitioned across the cluster members; each member owns and manages the + // * some portion of the entries. Owned entries are called local entries. This listener will be listening for the + // * events of local entries. Let's say your cluster has member1 and member2. On member2 you added a local listener and + // * from member1, you call <code>map.put(key2, value2)</code>. If the key2 is owned by member2 then the local listener + // * will be notified for the add/update event. Also note that entries can migrate to other nodes for load balancing + // * and/or membership change. + // * + // * @param listener entry listener + // * @see #localKeySet() + // */ + // void addLocalEntryListener(EntryListener<K, V> listener); + // + // /** + // * Adds an entry listener for this map. Listener will get notified for all map add/remove/update/evict events. + // * + // * @param listener entry listener + // * @param includeValue <tt>true</tt> if <tt>EntryEvent</tt> should contain the value. + // */ + // void addEntryListener(EntryListener<K, V> listener, boolean includeValue); + // + // /** + // * Removes the specified entry listener Returns silently if there is no such listener added before. + // * + // * @param listener entry listener + // */ + // void removeEntryListener(EntryListener<K, V> listener); + // + // /** + // * Adds the specified entry listener for the specified key. The listener will get notified for all + // * add/remove/update/evict events of the specified key only. + // * + // * @param listener entry listener + // * @param key key to listen + // * @param includeValue <tt>true</tt> if <tt>EntryEvent</tt> should contain the value. + // */ + // void addEntryListener(EntryListener<K, V> listener, K key, boolean includeValue); + // + // /** + // * Removes the specified entry listener for the specified key. Returns silently if there is no such listener added + // * before for the key. + // * + // * @param listener + // * @param key + // */ + // void removeEntryListener(EntryListener<K, V> listener, K key); +} diff --git a/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedMultiMap.java b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedMultiMap.java new file mode 100644 index 00000000000..dbcfcb68341 --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedMultiMap.java @@ -0,0 +1,198 @@ +/******************************************************************************* + * Copyright (c) 2004, 2007 Boeing. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Boeing - initial API and implementation + *******************************************************************************/ +package org.eclipse.osee.distributed; + +import java.util.Collection; +import java.util.Map; +import java.util.Set; +import java.util.concurrent.TimeUnit; + +/** + * @author Roberto E. Escobar + */ +public interface DistributedMultiMap<K, V> extends DistributedCollection { + + /** + * Stores a key-value pair in the multimap. + * + * @param key the key to be stored + * @param value the value to be stored + * @return true if size of the multimap is increased, false if the multimap already contains the key-value pair. + */ + boolean put(K key, V value); + + /** + * Returns the collection of values associated with the key. + * + * @param key the key whose associated values are to be returned + * @return the collection of the values associated with the key. + */ + Collection<V> get(K key); + + /** + * Removes the given key value pair from the multimap. + * + * @param key the key of the entry to remove + * @param value the value of the entry to remove + * @return true if the size of the multimap changed after the remove operation, false otherwise. + */ + boolean remove(Object key, Object value); + + /** + * Removes all the entries with the given key. + * + * @param key the key of the entries to remove + * @return the collection of removed values associated with the given key. Returned collection might be modifiable + * but it has no effect on the multimap + */ + Collection<V> remove(Object key); + + /** + * Returns the set of keys in the multimap. + * + * @return the set of keys in the multimap. Returned set might be modifiable but it has no effect on the multimap + */ + Set<K> keySet(); + + /** + * Returns the collection of values in the multimap. + * + * @return the collection of values in the multimap. Returned collection might be modifiable but it has no effect on + * the multimap + */ + Collection<V> values(); + + /** + * Returns the set of key-value pairs in the multimap. + * + * @return the set of key-value pairs in the multimap. Returned set might be modifiable but it has no effect on the + * multimap + */ + Set<Map.Entry<K, V>> entrySet(); + + /** + * Returns whether the multimap contains an entry with the key. + * + * @param key the key whose existence is checked. + * @return true if the multimap contains an entry with the key, false otherwise. + */ + boolean containsKey(K key); + + /** + * Returns whether the multimap contains an entry with the value. + * + * @param value the value whose existence is checked. + * @return true if the multimap contains an entry with the value, false otherwise. + */ + boolean containsValue(Object value); + + /** + * Returns whether the multimap contains the given key-value pair. + * + * @param key the key whose existence is checked. + * @param value the value whose existence is checked. + * @return true if the multimap contains the key-value pair, false otherwise. + */ + boolean containsEntry(K key, V value); + + /** + * Returns the number of key-value pairs in the multimap. + * + * @return the number of key-value pairs in the multimap. + */ + int size(); + + /** + * Clears the multimap. Removes all key-value pairs. + */ + void clear(); + + /** + * Returns number of values matching to given key in the multimap. + * + * @param key the key whose values count are to be returned + * @return number of values matching to given key in the multimap. + */ + int valueCount(K key); + + /** + * Acquires the lock for the specified key. + * <p> + * If the lock is not available then the current thread becomes disabled for thread scheduling purposes and lies + * dormant until the lock has been acquired. + * <p/> + * Scope of the lock is this multimap only. Acquired lock is only for the key in this multimap. + * <p/> + * Locks are re-entrant so if the key is locked N times then it should be unlocked N times before another thread can + * acquire it. + * + * @param key key to lock. + */ + void lock(K key); + + /** + * Tries to acquire the lock for the specified key. + * <p> + * If the lock is not available then the current thread doesn't wait and returns false immediately. + * + * @param key key to lock. + * @return <tt>true</tt> if lock is acquired, <tt>false</tt> otherwise. + */ + boolean tryLock(K key); + + /** + * Tries to acquire the lock for the specified key. + * <p> + * If the lock is not available then the current thread becomes disabled for thread scheduling purposes and lies + * dormant until one of two things happens: + * <ul> + * <li>The lock is acquired by the current thread; or + * <li>The specified waiting time elapses + * </ul> + * + * @param time the maximum time to wait for the lock + * @param timeunit the time unit of the <tt>time</tt> argument. + * @return <tt>true</tt> if the lock was acquired and <tt>false</tt> if the waiting time elapsed before the lock was + * acquired. + */ + boolean tryLock(K key, long time, TimeUnit timeunit); + + /** + * Releases the lock for the specified key. It never blocks and returns immediately. + * + * @param key key to lock. + */ + void unlock(K key); + + /** + * Tries to acquire the lock for the entire map. The thread that locks the map can do all the operations but other + * threads in the cluster cannot operate on the map. + * <p> + * If the lock is not available then the current thread becomes disabled for thread scheduling purposes and lies + * dormant until one of two things happens: + * <ul> + * <li>The lock is acquired by the current thread; or + * <li>The specified waiting time elapses + * </ul> + * + * @param time the maximum time to wait for the lock + * @param timeunit the time unit of the <tt>time</tt> argument. + * @return <tt>true</tt> if the lock was acquired and <tt>false</tt> if the waiting time elapsed before the lock was + * acquired. + */ + boolean lockMap(long time, TimeUnit timeunit); + + /** + * Unlocks the map. It never blocks and returns immediately. + */ + void unlockMap(); + +} diff --git a/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedObject.java b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedObject.java new file mode 100644 index 00000000000..630bbea5fb4 --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedObject.java @@ -0,0 +1,18 @@ +/******************************************************************************* + * Copyright (c) 2004, 2007 Boeing. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Boeing - initial API and implementation + *******************************************************************************/ +package org.eclipse.osee.distributed; + +/** + * @author Roberto E. Escobar + */ +public interface DistributedObject extends HasId, Disposeable { + // Base Object Interface +} diff --git a/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedSet.java b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedSet.java new file mode 100644 index 00000000000..6d525cee24a --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/DistributedSet.java @@ -0,0 +1,20 @@ +/******************************************************************************* + * Copyright (c) 2004, 2007 Boeing. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Boeing - initial API and implementation + *******************************************************************************/ +package org.eclipse.osee.distributed; + +import java.util.Set; + +/** + * @author Roberto E. Escobar + */ +public interface DistributedSet<E> extends Set<E>, DistributedCollection { + // +} diff --git a/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/HasId.java b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/HasId.java new file mode 100644 index 00000000000..4305e7825cc --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/HasId.java @@ -0,0 +1,20 @@ +/******************************************************************************* + * Copyright (c) 2004, 2007 Boeing. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Boeing - initial API and implementation + *******************************************************************************/ +package org.eclipse.osee.distributed; + +/** + * @author Roberto E. Escobar + */ +public interface HasId { + + Object getId(); + +} diff --git a/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/HasName.java b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/HasName.java new file mode 100644 index 00000000000..5c9ca00db05 --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/HasName.java @@ -0,0 +1,20 @@ +/******************************************************************************* + * Copyright (c) 2004, 2007 Boeing. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Boeing - initial API and implementation + *******************************************************************************/ +package org.eclipse.osee.distributed; + +/** + * @author Roberto E. Escobar + */ +public interface HasName { + + String getName(); + +} diff --git a/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/InstanceManager.java b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/InstanceManager.java new file mode 100644 index 00000000000..306263e603e --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/InstanceManager.java @@ -0,0 +1,38 @@ +/******************************************************************************* + * Copyright (c) 2004, 2007 Boeing. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Boeing - initial API and implementation + *******************************************************************************/ +package org.eclipse.osee.distributed; + +import java.util.List; +import java.util.Set; +import java.util.concurrent.BlockingQueue; + +/** + * @author Roberto E. Escobar + */ +public interface InstanceManager { + + AtomicNumber getAtomicNumber(String name); + + <E> BlockingQueue<E> getQueue(String name); + + <E> Set<E> getSet(String name); + + <E> List<E> getList(String name); + + <K, V> DistributedMap<K, V> getMap(String name); + + <K, V> DistributedMultiMap<K, V> getMultiMap(String name); + + DistributedId getIdGenerator(String name); + + DistributedLock getLock(Object key); + +} diff --git a/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/Predicate.java b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/Predicate.java new file mode 100644 index 00000000000..e885bfe3ee6 --- /dev/null +++ b/plugins/org.eclipse.osee.distributed/src/org/eclipse/osee/distributed/Predicate.java @@ -0,0 +1,21 @@ +/******************************************************************************* + * Copyright (c) 2004, 2007 Boeing. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * Boeing - initial API and implementation + *******************************************************************************/ +package org.eclipse.osee.distributed; + +import java.io.Serializable; +import java.util.Map; + +/** + * @author Roberto E. Escobar + */ +public interface Predicate<K, V> extends Serializable { + boolean apply(Map.Entry<K, V> mapEntry); +}
\ No newline at end of file |