View Javadoc

1   /*
2    * $Id: ListableObjectStore.java 21613 2011-03-28 13:20:58Z dirk.olmes $
3    * --------------------------------------------------------------------------------------
4    * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
5    *
6    * The software in this package is published under the terms of the CPAL v1.0
7    * license, a copy of which has been included with this distribution in the
8    * LICENSE.txt file.
9    */
10  
11  package org.mule.api.store;
12  
13  import java.io.Serializable;
14  import java.util.List;
15  
16  public interface ListableObjectStore<T extends Serializable> extends ObjectStore<T>
17  {
18      /**
19       * Open the underlying store.
20       *
21       * @throws ObjectStoreException if an exception occurred while opening the underlying store.
22       */
23      void open() throws ObjectStoreException;
24  
25      /**
26       * Close the underlying store.
27       *
28       * @throws ObjectStoreException if an exception occurred while closing the underlying store.
29       */
30      void close() throws ObjectStoreException;
31  
32      /**
33       * @return list containing all keys that this object store currently holds values for.
34       *
35       * @throws ObjectStoreException if an exception occurred while collecting the list of all keys.
36       */
37      List<Serializable> allKeys() throws ObjectStoreException;
38  }
39  
40