org.fujion.client

Class ClientRequest

java.lang.Object

org.fujion.client.ClientRequest

public class ClientRequest
extends Object

Represents a request from the client. At a minimum, a request must have a type that dictates which handler will process the request. Most requests will also have an associated page and a data payload. The format of the data payload is specific to the request type.

Constructor Summary

Constructors

Constructor and Description
ClientRequest(Session session, Map<String,Object> map) Creates a client request object from the request map.

Method Summary

Modifier and Type	Method and Description
Object	getData() Returns the data payload associated with the request.
<T> T	getData(Class<T> clazz) Returns the data payload associated with the request, coercing it to the specified type.
Page	getPage() The page with which this request is associated.
<T> T	getParam(String name, Class<T> type) Returns the named parameter from the request data.
<T> T	getParam(String name, Class<T> type, T deflt) Returns the named event parameter from the request.
Session	getSession() Return the session to which this request belongs.
String	getType() Returns the type of this request.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientRequest

public ClientRequest(Session session,
                     Map<String,Object> map)

Creates a client request object from the request map.

Parameters:

session - The session associated with this request.

map - The request map.

Method Detail

getPage

public Page getPage()

The page with which this request is associated.

Returns:

The associated page.

getSession

public Session getSession()

Return the session to which this request belongs.

Returns:

The session.

getData

public Object getData()

Returns the data payload associated with the request.

Returns:

The data payload (may be null).

getData

public <T> T getData(Class<T> clazz)

Returns the data payload associated with the request, coercing it to the specified type.

Type Parameters:

T - The data class.

Parameters:

clazz - The class of the payload.

Returns:

The data payload (may be null).

Throws:

ClassCastException - If the payload is not assignment-compatible with the specified class.

getType

public String getType()

Returns the type of this request.

Returns:

The type of the request.

getParam

public <T> T getParam(String name,
                      Class<T> type)

Returns the named parameter from the request data. This assumes that the request data is a map of parameter values. If not, null will always be returned. Performs intelligent conversion of datatypes where possible.

Type Parameters:

T - The expected parameter type.

Parameters:

name - The parameter name.

type - The expected parameter type.

Returns:

The parameter value, or null if not found.

getParam

public <T> T getParam(String name,
                      Class<T> type,
                      T deflt)

Returns the named event parameter from the request.

Type Parameters:

T - The expected parameter type.

Parameters:

name - The parameter name.

type - The expected parameter type.

deflt - The default value for the parameter.

Returns:

The parameter value, or the specified default if not found.