com.rexsl.page.inset

Class FlashInset

java.lang.Object

com.rexsl.page.inset.FlashInset

All Implemented Interfaces:

Inset

@Loggable(value=1)
public final class FlashInset
extends Object
implements Inset

Flash message (through cookie).

Since:

0.4.8

Version:

$Id$

Author:

Yegor Bugayenko (yegor@tpc2.com)

See Also:

BasePage, Flash messages in RESTful interfaces

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlashInset.Flash The cookie.

Nested classes/interfaces inherited from interface com.rexsl.page.Inset

Inset.Default, Inset.Runtime

Constructor Summary

Constructors

Constructor and Description
FlashInset(Resource res) Public ctor.

Method Summary

Methods

Modifier and Type	Method and Description
static JaxbBundle	bundle(Level level, String msg) Make a bundle.
static JaxbBundle	bundle(Level level, String msg, long msec) Make a bundle.
static javax.ws.rs.WebApplicationException	forward(URI uri, Exception cause) Throw an exception that will forward to the page with an error message.
static javax.ws.rs.WebApplicationException	forward(URI uri, String message, Level level) Create an exception that will forward to the page with an error message.
javax.ws.rs.WebApplicationException	redirect(URI uri, Exception cause) Create an exception that will redirect to the page with an error message.
javax.ws.rs.WebApplicationException	redirect(URI uri, String message, Level level) Create an exception that will redirect to the page with an error message.
void	render(BasePage<?,?> page, javax.ws.rs.core.Response.ResponseBuilder builder) Render it into the response builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlashInset

public FlashInset(@NotNull
          Resource res)

Public ctor.

Parameters:

res - The resource

Method Detail

render

public void render(@NotNull
          BasePage<?,?> page,
          @NotNull
          javax.ws.rs.core.Response.ResponseBuilder builder)

Description copied from interface: Inset

Render it into the response builder.

Specified by:

render in interface Inset

Parameters:

page - The page to render

builder - The builder

bundle

public static JaxbBundle bundle(@NotNull
                Level level,
                @NotNull
                String msg,
                long msec)

Make a bundle.

Parameters:

level - Logging level

msg - Message

msec - Time spent

Returns:

JaxbBundle injectable into the page

bundle

public static JaxbBundle bundle(Level level,
                String msg)

Make a bundle.

Parameters:

level - Logging level

msg - Message

Returns:

JaxbBundle injectable into the page

Since:

0.4.16

redirect

public javax.ws.rs.WebApplicationException redirect(@NotNull
                                           URI uri,
                                           @NotNull
                                           String message,
                                           @NotNull
                                           Level level)

Create an exception that will redirect to the page with an error message.

The difference between this method and a static forward(URI,String,Level) is in its awareness of a resource, which is forwarding. Key benefit is that a non-static method adds extra value to the cookie, which is time consumed by the resource until the redirect happened.

Parameters:

uri - The URI to forward to

message - The message to show as error

level - Message level

Returns:

The exception to throw

redirect

public javax.ws.rs.WebApplicationException redirect(@NotNull
                                           URI uri,
                                           @NotNull
                                           Exception cause)

Create an exception that will redirect to the page with an error message.

The difference between this method and a static forward(URI,Exception) is in its awareness of a resource, which is forwarding. Key benefit is that a non-static method adds extra value to the cookie, which is time consumed by the resource until the redirect happened.

Parameters:

uri - The URI to forward to

cause - The cause of this problem

Returns:

The exception to throw

forward

public static javax.ws.rs.WebApplicationException forward(@NotNull
                                          URI uri,
                                          @NotNull
                                          String message,
                                          @NotNull
                                          Level level)

Create an exception that will forward to the page with an error message.

Parameters:

uri - The URI to forward to

message - The message to show as error

level - Message level

Returns:

The exception to throw

forward

public static javax.ws.rs.WebApplicationException forward(@NotNull
                                          URI uri,
                                          @NotNull
                                          Exception cause)

Throw an exception that will forward to the page with an error message.

Parameters:

uri - The URI to forward to

cause - The cause of this problem

Returns:

The exception to throw