org.icefaces.mobi.util

Class SXUtils

java.lang.Object

org.icefaces.mobi.util.SXUtils

public class SXUtils
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COOKIE_FORMAT
static java.lang.String	SESSION_KEY_SX_REGISTERED
static java.lang.String	SX_THUMB_MAP
static java.lang.String	SX_UPLOAD
static java.lang.String	SX_UPLOAD_PROGRESS
static java.lang.String	USER_AGENT_SX_FULL
static java.lang.String	USER_AGENT_SX_PART

Constructor Summary

Constructors

Constructor and Description
SXUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	encodeParams(java.util.Map<java.lang.String,java.lang.String> params)
static java.util.Map<java.lang.String,java.io.File>	getAuxiliaryUploadMap(javax.servlet.http.HttpServletRequest request) The session map of the auxiliary uploads.
static int	getAuxiliaryUploadProgress(javax.servlet.http.HttpServletRequest request) Tracks the progress of an auxiliary upload with ICEmobile-SX.
static java.lang.String	getICEmobileRegisterSXScript(javax.servlet.http.HttpServletRequest request, java.lang.String uploadPath)
static java.lang.String	getICEmobileSXScript(javax.servlet.http.HttpServletRequest request, java.lang.String command, java.util.Map<java.lang.String,java.lang.String> params, java.lang.String id, java.lang.String sessionID, java.lang.String uploadPath)
static java.lang.String	getRegisterSXURL(javax.servlet.http.HttpServletRequest request) Get the default SX Register URL ending in /icemobile
static java.lang.String	getRegisterSXURL(javax.servlet.http.HttpServletRequest request, java.lang.String uploadPath) Get the SX Register URL.
static java.lang.String	getSessionIdCookie(javax.servlet.http.HttpServletRequest request)
static java.util.Map<java.lang.String,java.io.File>	getSXUploadThumbMap(javax.servlet.http.HttpServletRequest request)
static boolean	isSXRegistered(javax.servlet.http.HttpServletRequest request) Has the user registered ICEmobile-SX for the current application session?
static boolean	isSXRequest(javax.servlet.http.HttpServletRequest request) Is the current request from ICEmobile-SX
static void	setAuxUploadProgress(int progress, javax.servlet.http.HttpSession session)
static void	setSXSessionKeys(javax.servlet.http.HttpServletRequest request)

Methods inherited from class java.lang.Object

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

Field Detail

SX_UPLOAD

public static final java.lang.String SX_UPLOAD

See Also:

Constant Field Values

SX_UPLOAD_PROGRESS

public static final java.lang.String SX_UPLOAD_PROGRESS

See Also:

Constant Field Values

SX_THUMB_MAP

public static final java.lang.String SX_THUMB_MAP

See Also:

Constant Field Values

SESSION_KEY_SX_REGISTERED

public static final java.lang.String SESSION_KEY_SX_REGISTERED

See Also:

Constant Field Values

USER_AGENT_SX_PART

public static final java.lang.String USER_AGENT_SX_PART

See Also:

Constant Field Values

USER_AGENT_SX_FULL

public static final java.lang.String USER_AGENT_SX_FULL

See Also:

Constant Field Values

COOKIE_FORMAT

public static final java.lang.String COOKIE_FORMAT

See Also:

Constant Field Values

Constructor Detail

SXUtils

public SXUtils()

Method Detail

getRegisterSXURL

public static java.lang.String getRegisterSXURL(javax.servlet.http.HttpServletRequest request,
                                java.lang.String uploadPath)

Get the SX Register URL. Format is icemobile:c=register&r=&JSESSIONID=&u=

Parameters:

request - The servlet request

uploadPath - The path of the upload post from the context, eg 'icemobile' for JSP or 'javax.faces.resource./auxupload.txt.jsf' for JSF.

Returns:

The escaped SX register URL.

getRegisterSXURL

public static java.lang.String getRegisterSXURL(javax.servlet.http.HttpServletRequest request)

Get the default SX Register URL ending in /icemobile

Parameters:

request - The Servlet Request

Returns:

The full upload URL

isSXRegistered

public static boolean isSXRegistered(javax.servlet.http.HttpServletRequest request)

Has the user registered ICEmobile-SX for the current application session?

Parameters:

request - The ServletRequest

Returns:

true if SX has been registered, else false

isSXRequest

public static boolean isSXRequest(javax.servlet.http.HttpServletRequest request)

Is the current request from ICEmobile-SX

Parameters:

request - The Servlet Request

Returns:

true if request from SX, else false

setSXSessionKeys

public static void setSXSessionKeys(javax.servlet.http.HttpServletRequest request)

getAuxiliaryUploadProgress

public static int getAuxiliaryUploadProgress(javax.servlet.http.HttpServletRequest request)

Tracks the progress of an auxiliary upload with ICEmobile-SX. If no current upload is in progress, will return 0, otherwise 1-99.

Parameters:

request - The Servlet Request

Returns:

0, if no upload in progress, else 1-99

getAuxiliaryUploadMap

public static java.util.Map<java.lang.String,java.io.File> getAuxiliaryUploadMap(javax.servlet.http.HttpServletRequest request)

The session map of the auxiliary uploads. The map is keyed by the id of the uploading components.

Parameters:

request - The Servlet Request

Returns:

The session map of uploads.

getICEmobileSXScript

public static java.lang.String getICEmobileSXScript(javax.servlet.http.HttpServletRequest request,
                                    java.lang.String command,
                                    java.util.Map<java.lang.String,java.lang.String> params,
                                    java.lang.String id,
                                    java.lang.String sessionID,
                                    java.lang.String uploadPath)

encodeParams

public static java.lang.String encodeParams(java.util.Map<java.lang.String,java.lang.String> params)

getICEmobileRegisterSXScript

public static java.lang.String getICEmobileRegisterSXScript(javax.servlet.http.HttpServletRequest request,
                                            java.lang.String uploadPath)

setAuxUploadProgress

public static void setAuxUploadProgress(int progress,
                        javax.servlet.http.HttpSession session)

getSessionIdCookie

public static java.lang.String getSessionIdCookie(javax.servlet.http.HttpServletRequest request)

getSXUploadThumbMap

public static java.util.Map<java.lang.String,java.io.File> getSXUploadThumbMap(javax.servlet.http.HttpServletRequest request)