Package org.glassfish.tyrus.client.auth

Class AuthenticationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

org.glassfish.tyrus.core.HandshakeException

org.glassfish.tyrus.client.auth.AuthenticationException

All Implemented Interfaces:

Serializable

@Beta
public class AuthenticationException
extends HandshakeException

This exception is set as a cause of DeploymentException thrown when WebSocketContainer.connectToServer(...) fails because of any of the following:

• HTTP response status code 401 is received and ""WWW-Authenticate"" header contains scheme which is not handled by any Authenticator registered in AuthConfig.
• HTTP response status code 401 is received and ""WWW-Authenticate"" header does not contain authentication scheme token or ""WWW-Authenticate"" header is missing.
• AuthenticationException is thrown from Authenticator.generateAuthorizationHeader(URI, String, Credentials) method.
• Property ClientProperties.AUTH_CONFIG is not instance of AuthConfig.

HandshakeException.getHttpStatusCode() returns always 401.

Author:

Ondrej Kosatka

See Also:

• Authenticator.generateAuthorizationHeader(URI, String, Credentials)
• AuthConfig
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AuthenticationException(String message)	Constructor.

Method Summary

Methods inherited from class org.glassfish.tyrus.core.HandshakeException

getHttpStatusCode

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

Constructor Details

AuthenticationException

public AuthenticationException(String message)

Constructor.

Parameters:

message - the detail message. The detail message is saved for later retrieval by the Throwable.getMessage() method.