KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > jetspeed > portlet > UnavailableException


1 /* ====================================================================
2  * The Apache Software License, Version 1.1
3  *
4  * Copyright (c) 2000-2001 The Apache Software Foundation. All rights
5  * reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * 1. Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  * notice, this list of conditions and the following disclaimer in
16  * the documentation and/or other materials provided with the
17  * distribution.
18  *
19  * 3. The end-user documentation included with the redistribution,
20  * if any, must include the following acknowledgment:
21  * "This product includes software developed by the
22  * Apache Software Foundation (http://www.apache.org/)."
23  * Alternately, this acknowledgment may appear in the software itself,
24  * if and wherever such third-party acknowledgments normally appear.
25  *
26  * 4. The names "Apache" and "Apache Software Foundation" and
27  * "Apache Jetspeed" must not be used to endorse or promote products
28  * derived from this software without prior written permission. For
29  * written permission, please contact apache@apache.org.
30  *
31  * 5. Products derived from this software may not be called "Apache" or
32  * "Apache Jetspeed", nor may "Apache" appear in their name, without
33  * prior written permission of the Apache Software Foundation.
34  *
35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
38  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46  * SUCH DAMAGE.
47  * ====================================================================
48  *
49  * This software consists of voluntary contributions made by many
50  * individuals on behalf of the Apache Software Foundation. For more
51  * information on the Apache Software Foundation, please see
52  * <http://www.apache.org/>.
53  */
54
55 package org.apache.jetspeed.portlet;
56
57 /**
58  ** Use the <CODE>UnavailableException</CODE> when the instantiation
59  ** of a portlet fails.
60  **
61  ** @see Portlet#init(PortletConfig)
62  **
63  ** @author <A HREF="mailto:tboehme@us.ibm.com">Thomas F. Boehme</A>
64  **/
65
66 public class UnavailableException extends PortletException
67 {
68     private int unavailableSeconds;
69
70     /**
71      ** Constructs a new exception with the given text.
72      **
73      ** @param text
74      ** the exception text
75      **/
76
77     public UnavailableException (String JavaDoc text)
78     {
79         this (text, -1);
80     }
81
82     /**
83      ** Constructs a new exception with the given text and excepted
84      ** receovery time. The expected recovery time describes how
85      ** long the portlet is expected to be out of service.
86      **
87      ** @param text
88      ** the exception text
89      ** @param aSeconds
90      ** the number of seconds
91      **/
92
93     public UnavailableException (String JavaDoc text, int seconds)
94     {
95         super (text);
96
97         unavailableSeconds = seconds;
98     }
99
100     /**
101      ** Returns the number of seconds that this portlet is
102      ** expected to be temporarily unavailable.
103      **
104      ** <P>
105      ** If this method returns a negative number, the portlet
106      ** is permanently unavailable or cannot provide an
107      ** estimate of how long it will be unavailable. No
108      ** effort is made to correct for the time elapsed since
109      ** the exception was first reported.
110      **
111      ** @return the number of seconds of unavailability
112      **/
113
114     public int getUnavailableSeconds ()
115     {
116         return (unavailableSeconds);
117     }
118 }
119
Popular Tags