Package com.aquima.interactions.portal.exception

Class FlowAuthorizationException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.aquima.interactions.foundation.exception.AppException

com.aquima.interactions.flow.FlowException

com.aquima.interactions.flow.exception.FlowAccessException

com.aquima.interactions.portal.exception.FlowAuthorizationException

All Implemented Interfaces:

Serializable

public class FlowAuthorizationException
extends FlowAccessException

This exception is used to indicate the flow could not be accessed due to a required role not being present.

Since:

5.0

Author:

O. Kerpershoek

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
FlowAuthorizationException(String flowName, String message, String[] requiredRoles, boolean authenticated)	Constructs the exception with the required parameters.

Method Summary

Modifier and Type	Method	Description
String[]	getRequiredRoles()	Returns the roles needed to start a certain flow.
boolean	isAuthenticated()	Returns if the user is authenticated.

Methods inherited from class com.aquima.interactions.flow.exception.FlowAccessException

getFlowName

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

FlowAuthorizationException

public FlowAuthorizationException(String flowName,
 String message,
 String[] requiredRoles,
 boolean authenticated)

Constructs the exception with the required parameters.

Parameters:

flowName - the name of the flow that could not be accessed.

message - Message providing further information about the cause of the error.

requiredRoles - Array of roles that is required by the flow.

authenticated - Represents the logged in state of the user.

Method Details

getRequiredRoles

public String[] getRequiredRoles()

Returns the roles needed to start a certain flow.

Returns:

String[] of roles

isAuthenticated

public boolean isAuthenticated()

Returns if the user is authenticated.

Returns:

boolean