/* ======================================================================
The Bodington System Software License, Version 1.0
  
Copyright (c) 2001 The University of Leeds.  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 acknowledgement:  "This product includes
software developed by the University of Leeds
(http://www.bodington.org/)."  Alternately, this acknowledgement may
appear in the software itself, if and wherever such third-party
acknowledgements normally appear.

4.  The names "Bodington", "Nathan Bodington", "Bodington System",
"Bodington Open Source Project", and "The University of Leeds" must not be
used to endorse or promote products derived from this software without
prior written permission. For written permission, please contact
d.gardner@leeds.ac.uk.

5.  The name "Bodington" may not appear in the name of products derived
from this software without prior written permission of the University of
Leeds.

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO,  TITLE,  THE IMPLIED WARRANTIES 
OF QUALITY  AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO 
EVENT SHALL THE UNIVERSITY OF LEEDS 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 was originally created by the University of Leeds and may contain voluntary 
contributions from others.  For more information on the Bodington Open Source Project, please 
see http://bodington.org/

====================================================================== */

package org.bodington.server;

import org.bodington.pool.*;

/**
 * An exception that indicates any kind of abonormal processing with
 * BuildingServer and associated classes.
 * 
 * @author Jon Maber
 * @version 1
 */

public class BuildingServerException extends java.lang.Exception
	{

	private String friendly_message;

	/**
	 * Instantiates an exception.
	 * 
	 * @param s The message to display for this exception.
	 */
	public BuildingServerException( String s )
		{
		super( s );
		friendly_message = getMessage();
		}

	/**
	 * Instantiates an exception.
	 * @param s The message that caused this exception.
	 * @param friendly The message to display to the user.
	 */
	public BuildingServerException( String s, String friendly )
		{
		super( s );
		friendly_message = friendly;
		}

	public BuildingServerException( ObjectPoolException opex )
		{
		switch ( opex.getReason() )
			{
			case ObjectPoolException.REASON_TIMEOUT:
				friendly_message = 
					"The page request you made required a database operation but " +
					"the database is currently very busy.  Please try again later. ";
				break;
				
			case ObjectPoolException.REASON_MAX_OBJECTS:
			case ObjectPoolException.REASON_MAX_OBJECTS_AND_REQUESTS:
			case ObjectPoolException.REASON_MAX_REQUESTS:
				friendly_message = 
					"The page request you made required a database operation but " +
					"you already have a number of outstanding database operations " +
					"in progress.  Your page request was cancelled to prevent your " +
					"activity from reducing the performance of the service for other " +
					"users. " +
					"In future, when you click on a link or button please wait for " +
					"the page to be delivered. ";
				break;
				
			default:
				friendly_message = 
					"The page request you made required a database operation but " +
					"there was a technical problem obtaining one.  Please try again later. ";
				break;
			}
		
		}

	public String getMessage()
		{
		if ( super.getMessage() != null )
			return super.getMessage();
		
		return friendly_message;
		}
		
	public String friendlyMessage()
		{
		if ( friendly_message!= null )
			return friendly_message;
		return getMessage();
		}
	}