org.osgl.http

Class H.Flash

java.lang.Object

org.osgl.http.H.KV<H.Flash>

org.osgl.http.H.Flash

All Implemented Interfaces:

Serializable

Enclosing class:

H

public static final class H.Flash
extends H.KV<H.Flash>

A Flash represent a storage scope that attributes inside is valid only for one session interaction. This feature of flash makes it very good for server to pass one time information to client, e.g. form submission error message etc.

Like H.Session, you can store only String type information to flash, and the total number of information stored including keys and values shall not exceed 4096 bytes as flash is persisted as cookie in browser

See Also:

Serialized Form

Field Summary

Fields inherited from class org.osgl.http.H.KV

data

Constructor Summary

Constructors

Constructor and Description
Flash()

Method Summary

Modifier and Type	Method and Description
static H.Flash	current() Return a flash instance of the current execution context, For example from a ThreadLocal
static void	current(H.Flash flash) Set a flash instance into the current execution context, for example into a ThreadLocal
H.Flash	discard() Discard the whole output buffer of the flash but the data buffer is remain untouched.
H.Flash	discard(String key) Discard a data from the output buffer of the flash but the data buffer is remain untouched.
boolean	equals(Object obj)
String	error() Get the "error" message that has been added to the flash scope.
H.Flash	error(String message) Add an "error" message to the flash scope
H.Flash	error(String message, Object... args) Add an "error" message to the flash scope, with optional format arguments
H.Flash	keep() Keep all data that has been put into the flash for one time.
H.Flash	keep(String key) Keep a data that has been put into the flash for one time.
H.Flash	now(String key, String value) Add an attribute to the flash's current scope.
H.KV	out()
H.Flash	put(String key, Object value) Add an attribute to the flash scope.
H.Flash	put(String key, String value) Add an attribute to the flash scope.
static H.Flash	resolve(H.Cookie flashCookie) Resolve a Flash instance from a cookie.
H.Cookie	serialize(String flashKey) Serialize this Flash instance into a Cookie.
String	success() Get the "success" message that has been added to the flash scope.
H.Flash	success(String message) Add a "success" message to the flash scope
H.Flash	success(String message, Object... args) Add a "success" message to the flash scope, with optional format arguments

Methods inherited from class org.osgl.http.H.KV

changed, clear, contains, containsKey, dirty, empty, get, hashCode, isEmpty, keySet, load, me, remove, size, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Flash

public Flash()

Method Detail

put

public H.Flash put(String key,
                   String value)

Add an attribute to the flash scope. The data is added to both data buffer and the out buffer

Overrides:

put in class H.KV<H.Flash>

Parameters:

key - the key to index the attribute

value - the value of the attribute

Returns:

the flash instance

put

public H.Flash put(String key,
                   Object value)

Add an attribute to the flash scope. The value is in Object type, however it will be convert to its string representation before put into the flash

Overrides:

put in class H.KV<H.Flash>

Parameters:

key - the key to index the attribute

value - the value to be put into the flash

Returns:

this flash instance

now

public H.Flash now(String key,
                   String value)

Add an attribute to the flash's current scope. Meaning when next time the user request to the server, the attribute will not be there anymore.

Parameters:

key - the attribute key

value - the attribute value

Returns:

the flash instance

error

public H.Flash error(String message)

Add an "error" message to the flash scope

Parameters:

message - the error message

Returns:

the flash instance

See Also:

put(String, Object)

error

public H.Flash error(String message,
                     Object... args)

Add an "error" message to the flash scope, with optional format arguments

Parameters:

message - the message template

args - the format arguments

Returns:

this flash instance

error

public String error()

Get the "error" message that has been added to the flash scope.

Returns:

the "error" message or null if no error message has been added to the flash

success

public H.Flash success(String message)

Add a "success" message to the flash scope

Parameters:

message - the error message

Returns:

the flash instance

See Also:

put(String, Object)

success

public H.Flash success(String message,
                       Object... args)

Add a "success" message to the flash scope, with optional format arguments

Parameters:

message - the message template

args - the format arguments

Returns:

this flash instance

success

public String success()

Get the "success" message that has been added to the flash scope.

Returns:

the "success" message or null if no success message has been added to the flash

discard

public H.Flash discard(String key)

Discard a data from the output buffer of the flash but the data buffer is remain untouched. Meaning the app can still get the data put(String, Object) into the flash scope, however they will NOT be write to the client cookie, thus the next time client request the server, the app will not be able to get the info anymore

Parameters:

key - the key to the data to be discarded

Returns:

the flash instance

discard

public H.Flash discard()

Discard the whole output buffer of the flash but the data buffer is remain untouched. Meaning the app can still get the data put(String, Object) into the flash scope, however they will NOT be write to the client cookie, thus the next time client request the server, the app will not be able to get those info anymore

Returns:

the flash instance

keep

public H.Flash keep(String key)

Keep a data that has been put into the flash for one time. The data that has been kept will be persistent to client cookie for one time, thus the next time when user request the server, the app can still get the data, but only for one time unless the app call keep method again

Parameters:

key - the key to identify the data to be kept

Returns:

this flash

See Also:

keep()

keep

public H.Flash keep()

Keep all data that has been put into the flash for one time. The data that has been kept will be persistent to client cookie for one time, thus the next time when user request the server, the app can still get the data, but only for one time unless the app call keep method again

Returns:

the flash instance

out

public H.KV out()

current

public static H.Flash current()

Return a flash instance of the current execution context, For example from a ThreadLocal

Returns:

the current flash instance

current

public static void current(H.Flash flash)

Set a flash instance into the current execution context, for example into a ThreadLocal

Parameters:

flash - the flash to be set to current execution context

resolve

public static H.Flash resolve(H.Cookie flashCookie)

Resolve a Flash instance from a cookie. If the cookie supplied is null then an empty Flash instance is returned

Parameters:

flashCookie - the flash cookie

Returns:

a Flash instance

See Also:

serialize(String)

serialize

public H.Cookie serialize(String flashKey)

Serialize this Flash instance into a Cookie. Note the cookie returned has only name, value and max Age been set. It's up to the caller to set secure, path and httpOnly attributes.

Parameters:

flashKey - the cookie name

Returns:

a Cookie represent this flash instance

See Also:

resolve(org.osgl.http.H.Cookie)

equals

public boolean equals(Object obj)

Overrides:

equals in class H.KV<H.Flash>