org.apache.directory.shared.kerberos.exceptions

Class KerberosException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.apache.directory.shared.kerberos.exceptions.KerberosException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

ChangePasswordException, InvalidTicketException

public class KerberosException
extends java.lang.Exception

The root of the Kerberos exception hierarchy.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private KrbError	error the kerberos error
private int	errorCode The Kerberos error code associated with this exception.
private byte[]	explanatoryData Additional data about the error for use by the application to help it recover from or handle the error.
private static long	serialVersionUID

Constructor Summary

Constructors

Modifier	Constructor and Description
	KerberosException(ErrorType errorType) Creates a KerberosException with an ErrorType.
	KerberosException(ErrorType errorType, byte[] explanatoryData) Creates a KerberosException with an ErrorType and data helping to explain what caused this fault.
	KerberosException(ErrorType errorType, byte[] explanatoryData, java.lang.Throwable cause) Creates a KerberosException with an ErrorType, data helping to explain what caused this fault, and an underlying Throwable that caused this fault.
	KerberosException(ErrorType errorType, java.lang.String msg) Creates a KerberosException with an ErrorType and a custom error message.
	KerberosException(ErrorType errorType, java.lang.String msg, java.lang.Throwable cause) Creates a KerberosException with an ErrorType, a custom error message, and an underlying Throwable that caused this fault.
	KerberosException(ErrorType errorType, java.lang.Throwable cause) Creates a KerberosException with an ErrorType and an underlying Throwable that caused this fault.
protected	KerberosException(int errorCode, java.lang.String msg) Creates a KerberosException with an error code and a message.
protected	KerberosException(int errorCode, java.lang.String msg, byte[] explanatoryData) Creates a KerberosException with an error code, a message, and data helping to explain what caused this fault.
protected	KerberosException(int errorCode, java.lang.String msg, byte[] explanatoryData, java.lang.Throwable cause) Creates a KerberosException with an error code, a message, and data helping to explain what caused this fault.
protected	KerberosException(int errorCode, java.lang.String msg, java.lang.Throwable cause) Creates a KerberosException with an error code, a message and an underlying Throwable that caused this fault.
	KerberosException(KrbError error) Creates a new instance of KerberosException.

Method Summary

Modifier and Type	Method and Description
KrbError	getError() returns the KrbError message associated with this exception
int	getErrorCode() Gets the protocol error code associated with this KerberosException.
byte[]	getExplanatoryData() Gets the explanatory data associated with this KerberosException.

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

error

private KrbError error

the kerberos error

errorCode

private final int errorCode

The Kerberos error code associated with this exception.

explanatoryData

private byte[] explanatoryData

Additional data about the error for use by the application to help it recover from or handle the error.

Constructor Detail

KerberosException

public KerberosException(ErrorType errorType)

Creates a KerberosException with an ErrorType.

Parameters:

errorType - The error type associated with this KerberosException.

KerberosException

public KerberosException(KrbError error)

Creates a new instance of KerberosException.

Parameters:

error - the KrbError message

KerberosException

public KerberosException(ErrorType errorType,
                         java.lang.Throwable cause)

Creates a KerberosException with an ErrorType and an underlying Throwable that caused this fault.

Parameters:

errorType - The error type associated with this KerberosException.

cause - The underlying failure, if any.

KerberosException

public KerberosException(ErrorType errorType,
                         java.lang.String msg)

Creates a KerberosException with an ErrorType and a custom error message.

Parameters:

errorType - The ErrorType associated with this KerberosException.

msg - A custom error message for this KerberosException.

KerberosException

public KerberosException(ErrorType errorType,
                         java.lang.String msg,
                         java.lang.Throwable cause)

Creates a KerberosException with an ErrorType, a custom error message, and an underlying Throwable that caused this fault.

Parameters:

errorType - The error type associated with this KerberosException.

msg - A custom error message for this KerberosException.

cause - The underlying failure, if any.

KerberosException

public KerberosException(ErrorType errorType,
                         byte[] explanatoryData)

Creates a KerberosException with an ErrorType and data helping to explain what caused this fault.

Parameters:

errorType - The error type associated with this KerberosException.

explanatoryData - Data helping to explain this fault, if any.

KerberosException

public KerberosException(ErrorType errorType,
                         byte[] explanatoryData,
                         java.lang.Throwable cause)

Creates a KerberosException with an ErrorType, data helping to explain what caused this fault, and an underlying Throwable that caused this fault.

Parameters:

errorType - The error type associated with this KerberosException.

explanatoryData - Data helping to explain this fault, if any.

cause - The underlying failure, if any.

KerberosException

protected KerberosException(int errorCode,
                            java.lang.String msg)

Creates a KerberosException with an error code and a message.

Parameters:

errorCode - The error code associated with this KerberosException.

msg - The standard Kerberos error message for this KerberosException.

KerberosException

protected KerberosException(int errorCode,
                            java.lang.String msg,
                            java.lang.Throwable cause)

Creates a KerberosException with an error code, a message and an underlying Throwable that caused this fault.

Parameters:

errorCode - The error code associated with this KerberosException.

msg - The standard Kerberos error message for this KerberosException.

cause - The underlying failure, if any.

KerberosException

protected KerberosException(int errorCode,
                            java.lang.String msg,
                            byte[] explanatoryData)

Creates a KerberosException with an error code, a message, and data helping to explain what caused this fault.

Parameters:

errorCode - The error code associated with this KerberosException.

msg - The standard Kerberos error message for this KerberosException.

explanatoryData - Data helping to explain this fault, if any.

KerberosException

protected KerberosException(int errorCode,
                            java.lang.String msg,
                            byte[] explanatoryData,
                            java.lang.Throwable cause)

Creates a KerberosException with an error code, a message, and data helping to explain what caused this fault.

Parameters:

errorCode - The error code associated with this KerberosException.

msg - The standard Kerberos error message for this KerberosException.

explanatoryData - Data helping to explain this fault, if any.

cause - The underlying failure, if any.

Method Detail

getErrorCode

public int getErrorCode()

Gets the protocol error code associated with this KerberosException.

Returns:

The error code associated with this KerberosException.

getExplanatoryData

public byte[] getExplanatoryData()

Gets the explanatory data associated with this KerberosException.

Returns:

The explanatory data associated with this KerberosException.

getError

public KrbError getError()

returns the KrbError message associated with this exception

Returns:

the error, can be null