unavailableexception.java

来自「jetspeed源代码」· Java 代码 · 共 119 行

/* ====================================================================
 * The Apache Software License, Version 1.1
 *
 * Copyright (c) 2000-2001 The Apache Software Foundation.  All rights
 * reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 *
 * 3. The end-user documentation included with the redistribution,
 *    if any, must include the following acknowledgment:
 *       "This product includes software developed by the
 *        Apache Software Foundation (http://www.apache.org/)."
 *    Alternately, this acknowledgment may appear in the software itself,
 *    if and wherever such third-party acknowledgments normally appear.
 *
 * 4. The names "Apache" and "Apache Software Foundation" and
 *     "Apache Jetspeed" must not be used to endorse or promote products
 *    derived from this software without prior written permission. For
 *    written permission, please contact [e-mail].
 *
 * 5. Products derived from this software may not be called "Apache" or
 *    "Apache Jetspeed", nor may "Apache" appear in their name, without
 *    prior written permission of the Apache Software Foundation.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 * ====================================================================
 *
 * This software consists of voluntary contributions made by many
 * individuals on behalf of the Apache Software Foundation.  For more
 * information on the Apache Software Foundation, please see
 * <http://www.apache.org/>.
 */

package org.apache.jetspeed.portlet;

/**
 ** Use the <CODE>UnavailableException</CODE> when the instantiation
 ** of a portlet fails.
 **
 ** @see   Portlet#init(PortletConfig)
 **
 ** @author   <A HREF="mailto:[e-mail]">Thomas F. Boehme</A>
 **/

public class UnavailableException extends PortletException
{
    private int unavailableSeconds;

    /**
     ** Constructs a new exception with the given text.
     **
     ** @param   text
     **          the exception text
     **/

    public UnavailableException (String text)
    {
        this (text, -1);
    }

    /**
     ** Constructs a new exception with the given text and excepted
     ** receovery time. The expected recovery time describes how
     ** long the portlet is expected to be out of service.
     **
     ** @param   text
     **          the exception text
     ** @param   aSeconds
     **          the number of seconds
     **/

    public UnavailableException (String text, int seconds)
    {
        super (text);

        unavailableSeconds = seconds;
    }

    /**
     ** Returns the number of seconds that this portlet is
     ** expected to be temporarily unavailable.
     **
     ** <P>
     ** If this method returns a negative number, the portlet
     ** is permanently unavailable or cannot provide an
     ** estimate of how long it will be unavailable. No
     ** effort is made to correct for the time elapsed since
     ** the exception was first reported.
     **
     ** @return    the number of seconds of unavailability
     **/

    public int getUnavailableSeconds ()
    {
        return (unavailableSeconds);
    }
}