org.spincast.core.exceptions

Class RedirectException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.spincast.core.exceptions.RedirectException

All Implemented Interfaces:

Serializable

public class RedirectException
extends RuntimeException

Exception that will immediately send redirection headers and will make any remaining route handlers being skipped.

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
	RedirectException() Redirects to the current URL.
	RedirectException(FlashMessage flashMessage) Redirects to the current URL with a Flash message.
	RedirectException(FlashMessageLevel flashMessageType, String flashMessageTex) Redirects to the current URL with a Flash message.
	RedirectException(FlashMessageLevel flashMessageType, String flashMessageTex, JsonObject flashMessageVariables) Redirects to the current URL with a Flash message.
	RedirectException(String newUrl)
	RedirectException(String newUrl, boolean redirectPermanently)
protected	RedirectException(String newUrl, boolean redirectPermanently, FlashMessage flashMessage, FlashMessageLevel flashMessageType, String flashMessageText, JsonObject flashMessageVariables)
	RedirectException(String newUrl, boolean redirectPermanently, FlashMessageLevel flashMessageType, String flashMessageTex) Redirect with a Flash message.
	RedirectException(String newUrl, boolean redirectPermanently, FlashMessageLevel flashMessageType, String flashMessageTex, JsonObject flashMessageVariables) Redirect with a Flash message.
	RedirectException(String newUrl, FlashMessage flashMessage) Redirect with a Flash message.
	RedirectException(String newUrl, FlashMessageLevel flashMessageType, String flashMessageTex) Redirect with a Flash message.
	RedirectException(String newUrl, FlashMessageLevel flashMessageType, String flashMessageTex, JsonObject flashMessageVariables) Redirect with a Flash message.

Method Summary

Modifier and Type	Method and Description
FlashMessage	getFlashMessage() Can be null.
String	getFlashMessageText() Can be null.
FlashMessageLevel	getFlashMessageType() Can be null.
JsonObject	getFlashMessageVariables() Can be null.
String	getNewUrl() The new route to redirect to.
boolean	isRedirectPermanently() Is this a temporary or permanent redirection?

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 Detail

RedirectException

public RedirectException()

Redirects to the current URL.

RedirectException

public RedirectException(FlashMessage flashMessage)

Redirects to the current URL with a Flash message.

RedirectException

public RedirectException(FlashMessageLevel flashMessageType,
                         String flashMessageTex)

Redirects to the current URL with a Flash message.

RedirectException

public RedirectException(FlashMessageLevel flashMessageType,
                         String flashMessageTex,
                         JsonObject flashMessageVariables)

Redirects to the current URL with a Flash message.

RedirectException

public RedirectException(String newUrl)

Parameters:

newUrl - The new route to redirect to (not permanently). This can be a full URL or a relative path (+ a potential queryString)

RedirectException

public RedirectException(String newUrl,
                         FlashMessage flashMessage)

Redirect with a Flash message.

Parameters:

newUrl - The new route to redirect to (not permanently). This can be a full URL or a relative path (+ a potential queryString)

RedirectException

public RedirectException(String newUrl,
                         FlashMessageLevel flashMessageType,
                         String flashMessageTex)

Redirect with a Flash message.

Parameters:

newUrl - The new route to redirect to (not permanently). This can be a full URL or a relative path (+ a potential queryString)

RedirectException

public RedirectException(String newUrl,
                         FlashMessageLevel flashMessageType,
                         String flashMessageTex,
                         JsonObject flashMessageVariables)

Redirect with a Flash message.

Parameters:

newUrl - The new route to redirect to (not permanently). This can be a full URL or a relative path (+ a potential queryString)

RedirectException

public RedirectException(String newUrl,
                         boolean redirectPermanently)

Parameters:

newUrl - The new route to redirect to. This can be a full URL or a relative path (+ a potential queryString)

redirectPermanently - Is this a temporary or permanent redirection?

RedirectException

public RedirectException(String newUrl,
                         boolean redirectPermanently,
                         FlashMessageLevel flashMessageType,
                         String flashMessageTex)

Redirect with a Flash message.

Parameters:

newUrl - The new route to redirect to (not permanently). This can be a full URL or a relative path (+ a potential queryString)

redirectPermanently - Is this a temporary or permanent redirection?

RedirectException

public RedirectException(String newUrl,
                         boolean redirectPermanently,
                         FlashMessageLevel flashMessageType,
                         String flashMessageTex,
                         JsonObject flashMessageVariables)

Redirect with a Flash message.

Parameters:

newUrl - The new route to redirect to (not permanently). This can be a full URL or a relative path (+ a potential queryString)

redirectPermanently - Is this a temporary or permanent redirection?

RedirectException

protected RedirectException(String newUrl,
                            boolean redirectPermanently,
                            FlashMessage flashMessage,
                            FlashMessageLevel flashMessageType,
                            String flashMessageText,
                            JsonObject flashMessageVariables)

Parameters:

newUrl - The new route to redirect to. This can be a full URL or a relative path (+ a potential queryString)

redirectPermanently - Is this a temporary or permanent redirection?

flashMessage - a Flash message to display on the target url?

Method Detail

getNewUrl

public String getNewUrl()

The new route to redirect to. This can be a full URL or a relative path (+ a potential queryString)

isRedirectPermanently

public boolean isRedirectPermanently()

Is this a temporary or permanent redirection?

getFlashMessage

public FlashMessage getFlashMessage()

Can be null.

getFlashMessageType

public FlashMessageLevel getFlashMessageType()

Can be null.

getFlashMessageText

public String getFlashMessageText()

Can be null.

getFlashMessageVariables

public JsonObject getFlashMessageVariables()

Can be null.