KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > exolab > jms > lease > LeaseIfc


1 /**
2  * Redistribution and use of this software and associated documentation
3  * ("Software"), with or without modification, are permitted provided
4  * that the following conditions are met:
5  *
6  * 1. Redistributions of source code must retain copyright
7  * statements and notices. Redistributions must also contain a
8  * copy of this document.
9  *
10  * 2. Redistributions in binary form must reproduce the
11  * above copyright notice, this list of conditions and the
12  * following disclaimer in the documentation and/or other
13  * materials provided with the distribution.
14  *
15  * 3. The name "Exolab" must not be used to endorse or promote
16  * products derived from this Software without prior written
17  * permission of Exoffice Technologies. For written permission,
18  * please contact info@exolab.org.
19  *
20  * 4. Products derived from this Software may not be called "Exolab"
21  * nor may "Exolab" appear in their names without prior written
22  * permission of Exoffice Technologies. Exolab is a registered
23  * trademark of Exoffice Technologies.
24  *
25  * 5. Due credit should be given to the Exolab Project
26  * (http://www.exolab.org/).
27  *
28  * THIS SOFTWARE IS PROVIDED BY EXOFFICE TECHNOLOGIES AND CONTRIBUTORS
29  * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT
30  * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
31  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
32  * EXOFFICE TECHNOLOGIES OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
33  * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
34  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
35  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
36  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
37  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
38  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
39  * OF THE POSSIBILITY OF SUCH DAMAGE.
40  *
41  * Copyright 1999 (C) Exoffice Technologies Inc. All Rights Reserved.
42  *
43  * $Id: LeaseIfc.java,v 1.2 2005/03/18 03:47:30 tanderson Exp $
44  *
45  * Date Author Changes
46  * 2/29/2000 jima Created
47  */
48 package org.exolab.jms.lease;
49
50
51 /**
52  * A lease is used to track message exipration. It contains the object to be
53  * leased, the duration and the object to callback if or when the lease expirex
54  *
55  * @author <a HREF="mailto:jima@exoffice.com">Jim Alateras</a>
56  * @version $Revision: 1.2 $ $Date: 2005/03/18 03:47:30 $
57  */
58 public interface LeaseIfc {
59
60     /**
61      * Return the absolute expiry time of this lease.
62      *
63      * @return the expiry time of the lease, in milliseconds
64      */
65     public long getExpiryTime();
66
67     /**
68      * Returns the duration of the lease.
69      *
70      * @return the duration of the lease, in milliseconds
71      */
72     public long getDuration();
73
74     /**
75      * Returns the time remaining on the lease.
76      *
77      * @return the time remaining, in milliseconds
78      */
79     public long getRemainingTime();
80
81     /**
82      * Returns the leased object.
83      *
84      * @return the leased object
85      */
86     public Object JavaDoc getLeasedObject();
87
88 }
89
90
Popular Tags