001/*
002 * Copyright (c) 2003-2010 The Regents of the University of California.
003 * All rights reserved.
004 *
005 * '$Author: barseghian $'
006 * '$Date: 2013-01-16 23:35:49 +0000 (Wed, 16 Jan 2013) $' 
007 * '$Revision: 31341 $'
008 * 
009 * Permission is hereby granted, without written agreement and without
010 * license or royalty fees, to use, copy, modify, and distribute this
011 * software and its documentation for any purpose, provided that the above
012 * copyright notice and the following two paragraphs appear in all copies
013 * of this software.
014 *
015 * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
016 * FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
017 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
018 * THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
019 * SUCH DAMAGE.
020 *
021 * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
022 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
023 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
024 * PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
025 * CALIFORNIA HAS NO OBLIGATION TO PROVIDE MAINTENANCE, SUPPORT, UPDATES,
026 * ENHANCEMENTS, OR MODIFICATIONS.
027 *
028 */
029
030package org.kepler.authentication;
031
032/**
033 * This is an exception class for the authentication package to throw when
034 * there's an error.
035 */
036
037public class AuthenticationException extends Exception {
038        /**
039         * set this type if the exception is thrown because the user canceled the
040         * action
041         */
042        public static int USER_CANCEL = 1;
043
044        /**
045         * set this type if the exception is normal. this is the default.
046         */
047        public static int NORMAL = 2;
048
049        /**
050         * set this type if the auth failed due to bad pw or username
051         */
052        public static int BAD_USER = 3;
053
054        // set the default to normal
055        private int type = NORMAL;
056
057        /**
058         * constructor
059         */
060        public AuthenticationException() {
061                super();
062        }
063
064        /**
065         * constructor
066         */
067        public AuthenticationException(String msg) {
068                super(msg);
069        }
070
071        /**
072         * constructor
073         */
074        public AuthenticationException(String msg, Throwable cause) {
075                super(msg, cause);
076        }
077
078        /**
079         * constructor
080         */
081        public AuthenticationException(Throwable cause) {
082                super(cause);
083        }
084
085        /**
086         * set the type of this exception
087         */
088        public void setType(int type) {
089                this.type = type;
090        }
091
092        /**
093         * get the type of this exception
094         */
095        public int getType() {
096                return type;
097        }
098}