com.sun.gssapi

Class GSSException


public class GSSException
extends Exception

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
See Also:
MessageProp, GSSContext.unwrap, GSSContext.verifyMIC

Field Summary

static int
BAD_BINDINGS
Channel bindings mismatch error.
static int
BAD_MECH
Unsupported mechanism requested error.
static int
BAD_MIC
Token had invalid integrity check error.
static int
BAD_NAME
Invalid name provided error.
static int
BAD_NAMETYPE
Name of unsupported type provided error.
static int
BAD_QOP
Unsupported QOP value error.
static int
BAD_STATUS
Invalid status code error - this is the default status value.
static int
CONTEXT_EXPIRED
Specified security context expired error.
static int
CREDENTIALS_EXPIRED
Expired credentials detected error.
static int
DEFECTIVE_CREDENTIAL
Defective credential error.
static int
DEFECTIVE_TOKEN
Defective token error.
static int
DUPLICATE_ELEMENT
Duplicate credential element requested error.
static int
DUPLICATE_TOKEN
The token was a duplicate of an earlier token.
static int
FAILURE
General failure, unspecified at GSS-API level.
static int
GAP_TOKEN
An expected per-message token was not received.
static int
NAME_NOT_MN
Name contains multi-mechanism elements error.
static int
NO_CONTEXT
Invalid security context error.
static int
NO_CRED
Invalid credentials error.
static int
OLD_TOKEN
The token's validity period has expired.
static int
UNAUTHORIZED
Operation unauthorized error.
static int
UNAVAILABLE
Operation unavailable error.
static int
UNSEQ_TOKEN
A later token has already been processed.

Constructor Summary

GSSException(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

int
getMajor()
Returns the major code representing the error that caused this exception to be thrown.
String
getMajorString()
Returns a string explaining the major code in this exception.
String
getMessage()
Returns string representing both the major and minor status codes.
int
getMinor()
Returns the mechanism error that caused this exception.
String
getMinorString()
Returns a string explaining the mechanism specific error code.
void
setMinor(int minorCode, String message)
Used by the exception thrower to set the mechanism error code and its string explanation.
String
toString()
Returns string representing both the major and minor status codes.

Field Details

BAD_BINDINGS

public static final int BAD_BINDINGS
Channel bindings mismatch error.
Field Value:
1

BAD_MECH

public static final int BAD_MECH
Unsupported mechanism requested error.
Field Value:
2

BAD_MIC

public static final int BAD_MIC
Token had invalid integrity check error.
Field Value:
6

BAD_NAME

public static final int BAD_NAME
Invalid name provided error.
Field Value:
3

BAD_NAMETYPE

public static final int BAD_NAMETYPE
Name of unsupported type provided error.
Field Value:
4

BAD_QOP

public static final int BAD_QOP
Unsupported QOP value error.
Field Value:
14

BAD_STATUS

public static final int BAD_STATUS
Invalid status code error - this is the default status value.
Field Value:
5

CONTEXT_EXPIRED

public static final int CONTEXT_EXPIRED
Specified security context expired error.
Field Value:
7

CREDENTIALS_EXPIRED

public static final int CREDENTIALS_EXPIRED
Expired credentials detected error.
Field Value:
8

DEFECTIVE_CREDENTIAL

public static final int DEFECTIVE_CREDENTIAL
Defective credential error.
Field Value:
9

DEFECTIVE_TOKEN

public static final int DEFECTIVE_TOKEN
Defective token error.
Field Value:
10

DUPLICATE_ELEMENT

public static final int DUPLICATE_ELEMENT
Duplicate credential element requested error.
Field Value:
17

DUPLICATE_TOKEN

public static final int DUPLICATE_TOKEN
The 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.
Field Value:
19

FAILURE

public static final int FAILURE
General failure, unspecified at GSS-API level.
Field Value:
11

GAP_TOKEN

public static final int GAP_TOKEN
An 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.
Field Value:
22

NAME_NOT_MN

public static final int NAME_NOT_MN
Name contains multi-mechanism elements error.
Field Value:
18

NO_CONTEXT

public static final int NO_CONTEXT
Invalid security context error.
Field Value:
12

NO_CRED

public static final int NO_CRED
Invalid credentials error.
Field Value:
13

OLD_TOKEN

public static final int OLD_TOKEN
The 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.
Field Value:
20

UNAUTHORIZED

public static final int UNAUTHORIZED
Operation unauthorized error.
Field Value:
15

UNAVAILABLE

public static final int UNAVAILABLE
Operation unavailable error.
Field Value:
16

UNSEQ_TOKEN

public static final int UNSEQ_TOKEN
A 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.
Field Value:
21

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

public GSSException(int majorCode,
                    int minorCode,
                    String minorString)
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
Returns:
int the fatal error code causing this exception

getMajorString

public String getMajorString()
Returns a string explaining the major code in this exception.
RFC 2078
Returns:
String explanation string for the major error code

getMessage

public String getMessage()
Returns string representing both the major and minor status codes.
Returns:
a String with the error descriptions

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
Returns:
int the mechanism error code; 0 indicates that it has not been set.

getMinorString

public String 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
Returns:
String a textual explanation of mechanism error code

setMinor

public void setMinor(int minorCode,
                     String message)
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 code
message - textual explanation of the mechanism error code

toString

public String toString()
Returns string representing both the major and minor status codes.
Returns:
a String with the error descriptions