IASSecurityException.java

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright (c) 1997-2010 Oracle and/or its affiliates. All rights reserved.
 *
 * The contents of this file are subject to the terms of either the GNU
 * General Public License Version 2 only ("GPL") or the Common Development
 * and Distribution License("CDDL") (collectively, the "License").  You
 * may not use this file except in compliance with the License.  You can
 * obtain a copy of the License at
 * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html
 * or packager/legal/LICENSE.txt.  See the License for the specific
 * language governing permissions and limitations under the License.
 *
 * When distributing the software, include this License Header Notice in each
 * file and include the License file at packager/legal/LICENSE.txt.
 *
 * GPL Classpath Exception:
 * Oracle designates this particular file as subject to the "Classpath"
 * exception as provided by Oracle in the GPL Version 2 section of the License
 * file that accompanied this code.
 *
 * Modifications:
 * If applicable, add the following below the License Header, with the fields
 * enclosed by brackets [] replaced by your own identifying information:
 * "Portions Copyright [year] [name of copyright owner]"
 *
 * Contributor(s):
 * If you wish your version of this file to be governed by only the CDDL or
 * only the GPL Version 2, indicate your decision by adding "[Contributor]
 * elects to include this software in this distribution under the [CDDL or GPL
 * Version 2] license."  If you don't indicate a single choice of license, a
 * recipient has the option to distribute your version of this file under
 * either the CDDL, the GPL Version 2 or to extend the choice of license to
 * its licensees as provided above.  However, if you add GPL Version 2 code
 * and therefore, elected the GPL Version 2 license, then the option applies
 * only if the new code is made subject to such option by the copyright
 * holder.
 */

package com.sun.enterprise.security.util;

import java.lang.*;

/**
 * General exception class for iAS security failures.
 *
 * <P>This class takes advantage of the JDK1.4 Throwable objects which
 * can carry the original cause of the exception. This prevents losing
 * the information on what caused the problem to arise.
 *
 * <P>Ideally there should be common top level iAS Exceptions to extend.
 *
 */

public class IASSecurityException extends Exception
{
  private boolean noMsg;
  
  /**
   * Constructor.
   *
   * @param msg The detail message.
   *
   */
  public IASSecurityException(String msg)
  {
    super(msg);
    noMsg=false;
  }


  /**
   * Constructor.
   *
   * @param msg The detail message.
   * @param cause The cause (which is saved for later retrieval by the
   *    getCause() method).
   *
   */
  public IASSecurityException(String msg, Throwable cause)
  {
    super(msg, cause);
    noMsg=false;
  }


  /**
   * Constructor.
   *
   * @param cause The cause (which is saved for later retrieval by the
   *    getCause() method).
   *
   */
  public IASSecurityException(Throwable cause)
  {
    super(cause);
    noMsg=true;
  }


  /**
   * Returns a description of this exception. If a root cause was included
   * during construction, its message is also included.
   *
   * @return Message containing information about the exception.
   *
   */
  public String getMessage()
  {
    StringBuffer sb=new StringBuffer();
    sb.append(super.getMessage());
    Throwable cause=getCause();

    if (!noMsg && cause!=null) {
      sb.append(" [Cause: ");
      sb.append(cause.toString());
      sb.append("] ");
    }

    return sb.toString();
  }




}