Package com.spotfire.server.security

Class CustomWebAuthenticatorException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.spotfire.server.security.CustomAuthenticatorException

com.spotfire.server.security.CustomWebAuthenticatorException

All Implemented Interfaces:

Serializable

public class CustomWebAuthenticatorException
extends CustomAuthenticatorException

Exception thrown by implementations of CustomWebAuthenticator. Differs from the base class in that it can take extra information that determines the options the user will have on the error page.

Since:

7.8

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CustomWebAuthenticatorException(String message)	Constructs a new instance with the specified detail message.
CustomWebAuthenticatorException(String message, String providerName, String targetUrl)	Constructs a new instance with the specified detail message, provider name and target URL.
CustomWebAuthenticatorException(String message, Throwable cause)	Constructs a new instance with the specified detail message and cause.
CustomWebAuthenticatorException(String message, Throwable cause, String providerName, String targetUrl)	Constructs a new instance with the specified detail message, cause, provider name and target URL.

Method Summary

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

CustomWebAuthenticatorException

public CustomWebAuthenticatorException(String message)

Constructs a new instance with the specified detail message.

If possible use CustomWebAuthenticatorException(String, String, String) instead.

Parameters:

message - the detail message

Since:

7.8

CustomWebAuthenticatorException

public CustomWebAuthenticatorException(String message,
 String providerName,
 String targetUrl)

Constructs a new instance with the specified detail message, provider name and target URL. The provider name should be the name of the originally selected provider and the target URL should be the original target URL (provided to CustomWebAuthenticator.getAuthenticationEndpoint(java.util.Map, String, String)) - if given these will be used to give the user the option to retry the authentication (using the same provider).

Parameters:

message - the detail message

providerName - the name of the originally selected provider, or null

targetUrl - the URL of the resource the user originally tried to access, or null

Since:

7.8

CustomWebAuthenticatorException

public CustomWebAuthenticatorException(String message,
 Throwable cause)

Constructs a new instance with the specified detail message and cause.

If possible use CustomWebAuthenticatorException(String, Throwable, String, String) instead.

Parameters:

message - the detail message

cause - the cause

Since:

7.8

CustomWebAuthenticatorException

public CustomWebAuthenticatorException(String message,
 Throwable cause,
 String providerName,
 String targetUrl)

Constructs a new instance with the specified detail message, cause, provider name and target URL. The provider name should be the name of the originally selected provider and the target URL should be the original target URL (provided to CustomWebAuthenticator.getAuthenticationEndpoint(java.util.Map, String, String)) - if given these will be used to give the user the option to retry the authentication (using the same provider).

Parameters:

message - the detail message

cause - the cause

providerName - the name of the originally selected provider, or null

targetUrl - the URL of the resource the user originally tried to access, or null

Since:

7.8