Package com.aquima.web.api.exception

Class AbstractStartForbiddenException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.aquima.interactions.foundation.exception.AppException

com.aquima.web.api.exception.AbstractStartForbiddenException

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

StartApplicationForbiddenException, StartShortcutForbiddenException

public abstract class AbstractStartForbiddenException
extends com.aquima.interactions.foundation.exception.AppException

Base class for exceptions thrown when an authenticated user is attempting to start a project but does not have the required roles to do so. This is different from UnauthorizedException, which should be thrown when an unauthenticated user is attempting to start a project which requires login first.

Since:

11.7

Author:

Petru Galanton

See Also:

• StartApplicationForbiddenException
• StartShortcutForbiddenException
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
AbstractStartForbiddenException(String message)

Method Summary

Modifier and Type	Method	Description
String	getSsoLogoutUrl()	Returns the URL where the user can log out from the identity provider, if available.
boolean	isSsoEnabled()	Indicates whether single sign-on is enabled.
void	setSsoEnabled(boolean ssoEnabled)	Sets whether single sign-on is enabled.
void	setSsoLogoutUrl(String ssoLogoutUrl)	Sets the identity provider's logout URL, if available.

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

AbstractStartForbiddenException

public AbstractStartForbiddenException(String message)

Method Details

isSsoEnabled

public boolean isSsoEnabled()

Indicates whether single sign-on is enabled. When SSO is enabled, the exception handling may include logging out from the identity provider before attempting to log in again with a different user.

Returns:

true if signle sign-on is enabled, false otherwise.

setSsoEnabled

public void setSsoEnabled(boolean ssoEnabled)

Sets whether single sign-on is enabled.

Parameters:

ssoEnabled - true if single sign-on is enabled.

getSsoLogoutUrl

public String getSsoLogoutUrl()

Returns the URL where the user can log out from the identity provider, if available. Note that having single sign-on enabled does not imply that a SSO logout URL is available.

When this method returns a value, the exception handling may include providing a link to this URL to the user. The user may want to log out from the identity provider and log in with a different account before attempting to restart the project.

Returns:

the identity provider's logout URL if available, null otherwise.

setSsoLogoutUrl

public void setSsoLogoutUrl(String ssoLogoutUrl)

Sets the identity provider's logout URL, if available.

Parameters:

ssoLogoutUrl - the logout URL