← Back to branch summary

~ubuntu-branches/ubuntu/wily/libjboss-remoting-java/wily

« back to all changes in this revision

Viewing changes to src/org/jboss/remoting/SerializableStore.java

  • Committer: Package Import Robot
  • Author(s): Torsten Werner
  • Date: 2011-09-09 14:01:03 UTC
  • mfrom: (1.1.6 upstream)
  • Revision ID: package-import@ubuntu.com-20110909140103-hqokx61534tas9rg
Tags: 2.5.3.SP1-1
http://bugs.debian.org/628303
* Newer but not newest upstream release. Do not build samples.
* Change debian/watch to upstream's svn repo.
* Add patch to fix compile error caused by tomcat update.
  (Closes: #628303)
* Switch to source format 3.0.
* Switch to debhelper level 7.
* Remove useless Depends.
* Update Standards-Version: 3.9.2.
* Update README.source.

Show diffs side-by-side

added added

removed removed

Lines of Context:
src/org/jboss/remoting/SerializableStore.java
1
 
/*
2
 
* JBoss, Home of Professional Open Source
3
 
* Copyright 2005, JBoss Inc., and individual contributors as indicated
4
 
* by the @authors tag. See the copyright.txt in the distribution for a
5
 
* full listing of individual contributors.
6
 
*
7
 
* This is free software; you can redistribute it and/or modify it
8
 
* under the terms of the GNU Lesser General Public License as
9
 
* published by the Free Software Foundation; either version 2.1 of
10
 
* the License, or (at your option) any later version.
11
 
*
12
 
* This software is distributed in the hope that it will be useful,
13
 
* but WITHOUT ANY WARRANTY; without even the implied warranty of
14
 
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15
 
* Lesser General Public License for more details.
16
 
*
17
 
* You should have received a copy of the GNU Lesser General Public
18
 
* License along with this software; if not, write to the Free
19
 
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
20
 
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
21
 
*/
22
 
package org.jboss.remoting;
23
 
 
24
 
import java.io.IOException;
25
 
import java.io.Serializable;
26
 
import java.util.Map;
27
 
 
28
 
/**
29
 
 * @author <a href="mailto:telrod@e2technologies.net">Tom Elrod</a>
30
 
 */
31
 
public interface SerializableStore
32
 
{
33
 
   /**
34
 
    * Getst the number of objects stored and available.
35
 
    *
36
 
    * @return
37
 
    */
38
 
   int size();
39
 
 
40
 
   /**
41
 
    * Will look through the files in the store directory for the oldest object serialized to disk, load it,
42
 
    * delete the file, and return the deserialized object.
43
 
    * Important to note that once this object is returned from this method, it is gone forever from this
44
 
    * store and will not be able to retrieve it again without adding it back.
45
 
    *
46
 
    * @return
47
 
    * @throws java.io.IOException
48
 
    */
49
 
   Object getNext() throws IOException;
50
 
 
51
 
   /**
52
 
    * Persists the serializable object passed to the directory specified.  The file name will be the current time
53
 
    * in milliseconds (vis System.currentTimeMillis()) with the specified suffix.  This object can later be
54
 
    * retrieved using the getNext() method, but objects will be returned in the order that they were added (FIFO).
55
 
    *
56
 
    * @param object
57
 
    * @throws java.io.IOException
58
 
    */
59
 
   void add(Serializable object) throws IOException;
60
 
 
61
 
   /**
62
 
    * Will use the values in the map to set configuration.
63
 
    *
64
 
    * @param config
65
 
    */
66
 
   void setConfig(Map config);
67
 
 
68
 
   /**
69
 
    * Will get the file path value (if not already set will just use the
70
 
    * default setting) and will create the directory specified by the file path
71
 
    * if it does not already exist.
72
 
    *
73
 
    * @throws Exception
74
 
    */
75
 
   void start() throws Exception;
76
 
 
77
 
   /**
78
 
    * This will allow for change of file suffix and file path and then may start again
79
 
    * using these new values.  However, any object already written out using the old
80
 
    * values will be lost as will not longer be accessible if these attributes are changed while stopped.
81
 
    */
82
 
   void stop();
83
 
 
84
 
   /**
85
 
    * This is a no op method, but needed in order to be used as a service within JBoss AS.
86
 
    *
87
 
    * @throws Exception
88
 
    */
89
 
   void create() throws Exception;
90
 
 
91
 
   /**
92
 
    * This is a no op method, but needed in order to be used as a service within JBoss AS.
93
 
    */
94
 
   void destroy();
95
 
 
96
 
   /**
97
 
    * Sets if store should clean up persisted files when shutdown (destroy()).
98
 
    *
99
 
    * @param purgeOnShutdown
100
 
    */
101
 
   void setPurgeOnShutdown(boolean purgeOnShutdown);
102
 
 
103
 
   /**
104
 
    * Returns if store will clean up persisted files when shutdown (destroy()).
105
 
    *
106
 
    * @return
107
 
    */
108
 
   boolean getPurgeOnShutdown();
109
 
 
110
 
   void purgeFiles();
111
 
}