javax.security.sasl

Class SaslException

Implemented Interfaces:
Serializable
Known Direct Subclasses:
AuthenticationException

public class SaslException
extends IOException
implements Serializable

This class represents an error that has occurred when using SASL.
Since:
1.5
See Also:
Serialized Form

Constructor Summary

SaslException()
Constructs a new instance of SaslException.
SaslException(String detail)
Constructs a new instance of SaslException with a detailed message.
SaslException(String detail, Throwable ex)
Constructs a new instance of SaslException with a detailed message and a root exception.

Method Summary

Throwable
getCause()
Returns the cause of this throwable or null if the cause is nonexistent or unknown.
void
printStackTrace()
Prints this exception's stack trace to System.err.
void
printStackTrace(PrintStream ps)
Prints this exception's stack trace to a print stream.
void
printStackTrace(PrintWriter pw)
Prints this exception's stack trace to a print writer.
String
toString()
Returns the string representation of this exception.

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SaslException

public SaslException()
Constructs a new instance of SaslException. The root exception and the detailed message are null.

SaslException

public SaslException(String detail)
Constructs a new instance of SaslException with a detailed message. The root exception is null.
Parameters:
detail - a possibly null string containing details of the exception.

SaslException

public SaslException(String detail,
                     Throwable ex)
Constructs a new instance of SaslException with a detailed message and a root exception. For example, a SaslException might result from a problem with the callback handler, which might throw a UnsupportedCallbackException if it does not support the requested callback, or throw an IOException if it had problems obtaining data for the callback. The SaslException's root exception would be then be the exception thrown by the callback handler.
Parameters:
detail - a possibly null string containing details of the exception.
ex - a possibly null root exception that caused this exception.

Method Details

getCause

public Throwable getCause()
Returns the cause of this throwable or null if the cause is nonexistent or unknown. The cause is the throwable that caused this exception to be thrown.
Overrides:
getCause in interface Throwable
Returns:
the possibly null exception that caused this exception.

printStackTrace

public void printStackTrace()
Prints this exception's stack trace to System.err. If this exception has a root exception; the stack trace of the root exception is also printed to System.err.
Overrides:
printStackTrace in interface Throwable

printStackTrace

public void printStackTrace(PrintStream ps)
Prints this exception's stack trace to a print stream. If this exception has a root exception; the stack trace of the root exception is also printed to the print stream.
Overrides:
printStackTrace in interface Throwable
Parameters:
ps - the non-null print stream to which to print.

printStackTrace

public void printStackTrace(PrintWriter pw)
Prints this exception's stack trace to a print writer. If this exception has a root exception; the stack trace of the root exception is also printed to the print writer.
Overrides:
printStackTrace in interface Throwable
Parameters:
pw - the non-null print writer to use for output.

toString

public String toString()
Returns the string representation of this exception. The string representation contains this exception's class name, its detailed messsage, and if it has a root exception, the string representation of the root exception. This string representation is meant for debugging and not meant to be interpreted programmatically.
Overrides:
toString in interface Throwable
Returns:
the non-null string representation of this exception.

SaslException.java Copyright (C) 2003, 2005, Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.