Package com.sun.gssapi
Class GSSException
java.lang.Object
java.lang.Throwable
java.lang.Exception
com.sun.gssapi.GSSException
- All Implemented Interfaces:
Serializable
This exception is thrown whenever a fatal GSS-API error occurs
including mechanism specific errors. It contains
both the major and minor JGSS status codes. The mechanism
implementers are responsible for setting appropriate minor status
codes when throwing this exception. Methods are included to retrieve
the error string representation for both major and minor codes.
- RFC 2078
- GSS-API major status codes are divided into fatal and informatory status codes. In JGSS, fatal codes are represented using exceptions of this class, and informatory codes are returned through instances of the MesssageProp class used in the GSSContext methods. This class also provides the functionality of gss_display_status.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Channel bindings mismatch error.static final int
Unsupported mechanism requested error.static final int
Token had invalid integrity check error.static final int
Invalid name provided error.static final int
Name of unsupported type provided error.static final int
Unsupported QOP value error.static final int
Invalid status code error - this is the default status value.static final int
Specified security context expired error.static final int
Expired credentials detected error.static final int
Defective credential error.static final int
Defective token error.static final int
Duplicate credential element requested error.static final int
The token was a duplicate of an earlier token.static final int
General failure, unspecified at GSS-API level.static final int
An expected per-message token was not received.static final int
Name contains multi-mechanism elements error.static final int
Invalid security context error.static final int
Invalid credentials error.static final int
The token's validity period has expired.static final int
Operation unauthorized error.static final int
Operation unavailable error.static final int
A later token has already been processed. -
Constructor Summary
ConstructorsConstructorDescriptionGSSException
(int majorCode) Construct a GSSException object with a specified major code.GSSException
(int majorCode, int minorCode, String minorString) Construct a GSSException object with a specified major and minor codes and minor explanation string. -
Method Summary
Modifier and TypeMethodDescriptionint
getMajor()
Returns the major code representing the error that caused this exception to be thrown.Returns a string explaining the major code in this exception.Returns string representing both the major and minor status codes.int
getMinor()
Returns the mechanism error that caused this exception.Returns a string explaining the mechanism specific error code.void
Used by the exception thrower to set the mechanism error code and its string explanation.toString()
Returns string representing both the major and minor status codes.Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace
-
Field Details
-
BAD_BINDINGS
public static final int BAD_BINDINGSChannel bindings mismatch error.- See Also:
-
BAD_MECH
public static final int BAD_MECHUnsupported mechanism requested error.- See Also:
-
BAD_NAME
public static final int BAD_NAMEInvalid name provided error.- See Also:
-
BAD_NAMETYPE
public static final int BAD_NAMETYPEName of unsupported type provided error.- See Also:
-
BAD_STATUS
public static final int BAD_STATUSInvalid status code error - this is the default status value.- See Also:
-
BAD_MIC
public static final int BAD_MICToken had invalid integrity check error.- See Also:
-
CONTEXT_EXPIRED
public static final int CONTEXT_EXPIREDSpecified security context expired error.- See Also:
-
CREDENTIALS_EXPIRED
public static final int CREDENTIALS_EXPIREDExpired credentials detected error.- See Also:
-
DEFECTIVE_CREDENTIAL
public static final int DEFECTIVE_CREDENTIALDefective credential error.- See Also:
-
DEFECTIVE_TOKEN
public static final int DEFECTIVE_TOKENDefective token error.- See Also:
-
FAILURE
public static final int FAILUREGeneral failure, unspecified at GSS-API level.- See Also:
-
NO_CONTEXT
public static final int NO_CONTEXTInvalid security context error.- See Also:
-
NO_CRED
public static final int NO_CREDInvalid credentials error.- See Also:
-
BAD_QOP
public static final int BAD_QOPUnsupported QOP value error.- See Also:
-
UNAUTHORIZED
public static final int UNAUTHORIZEDOperation unauthorized error.- See Also:
-
UNAVAILABLE
public static final int UNAVAILABLEOperation unavailable error.- See Also:
-
DUPLICATE_ELEMENT
public static final int DUPLICATE_ELEMENTDuplicate credential element requested error.- See Also:
-
NAME_NOT_MN
public static final int NAME_NOT_MNName contains multi-mechanism elements error.- See Also:
-
DUPLICATE_TOKEN
public static final int DUPLICATE_TOKENThe token was a duplicate of an earlier token. This is a fatal error code that may occur during context establishment. It is not used to indicate supplementary status values. The MessageProp object is used for that purpose.- See Also:
-
OLD_TOKEN
public static final int OLD_TOKENThe token's validity period has expired. This is a fatal error code that may occur during context establishment. It is not used to indicate supplementary status values. The MessageProp object is used for that purpose.- See Also:
-
UNSEQ_TOKEN
public static final int UNSEQ_TOKENA later token has already been processed. This is a fatal error code that may occur during context establishment. It is not used to indicate supplementary status values. The MessageProp object is used for that purpose.- See Also:
-
GAP_TOKEN
public static final int GAP_TOKENAn expected per-message token was not received. This is a fatal error code that may occur during context establishment. It is not used to indicate supplementary status values. The MessageProp object is used for that purpose.- See Also:
-
-
Constructor Details
-
GSSException
public GSSException(int majorCode) Construct a GSSException object with a specified major code.- Parameters:
majorCode
- the fatal error code causing this exception. This value should be one of the ones defined in this class. Invalid error codes get mapped to BAD_STATUS value.
-
GSSException
Construct a GSSException object with a specified major and minor codes and minor explanation string.- Parameters:
majorCode
- the fatal error code causing this exception. This value should be one of the ones defined in this class. Invalid error codes get mapped to BAD_STATUS value.minorCode
- the mechanism specific error code.minorString
- explanation of the minorCode.
-
-
Method Details
-
getMajor
public int getMajor()Returns the major code representing the error that caused this exception to be thrown.- RFC 2078
- equivalent to major code being returned from function
- Returns:
- int the fatal error code causing this exception
- See Also:
-
getMinor
public int getMinor()Returns the mechanism error that caused this exception. The minor code is set by the underlying mechanism. Value of 0 indicates that mechanism error code is not set.- RFC 2078
- equivalent to minor status codes in GSS-API functions
- Returns:
- int the mechanism error code; 0 indicates that it has not been set.
- See Also:
-
getMajorString
Returns a string explaining the major code in this exception.- RFC 2078
- equivalent to gss_display_status for the major error code.
- Returns:
- String explanation string for the major error code
- See Also:
-
getMinorString
Returns a string explaining the mechanism specific error code. Can be used with the getMajorString call to provide mechanism specific error details. If the minor status code is 0, then no other error details will be available.- RFC 2078
- equivalent to gss_display_status for the minor code.
- Returns:
- String a textual explanation of mechanism error code
- See Also:
-
setMinor
Used by the exception thrower to set the mechanism error code and its string explanation. This is used by mechanism providers to indicate error details.- Parameters:
minorCode
- the mechanism specific error codemessage
- textual explanation of the mechanism error code
-
toString
Returns string representing both the major and minor status codes. -
getMessage
Returns string representing both the major and minor status codes.- Overrides:
getMessage
in classThrowable
- Returns:
- a String with the error descriptions
-