com.neurosys.utils

Class WicketUtils

java.lang.Object

com.neurosys.utils.WicketUtils

public class WicketUtils
extends Object

Wicket Related utils

Author:

Arjun Dhar

Constructor Summary

Constructors

Constructor and Description
WicketUtils()

Method Summary

Modifier and Type	Method and Description
static org.apache.wicket.markup.html.WebComponent	appendMissingCss(org.apache.wicket.markup.html.WebComponent wc, String... missingClassDef) If model-data failed to load for the given component to be rendered, then can append a 'missing-data' class Just a convenience method
static String	createPageLink(List<String> paramInclude, List<String> paramIgnore, String prefix, org.apache.wicket.Request request, String suffix) Re-Create a link with specific params only; cleans by recreating link with required params only
static void	feedback(List<Status> feedbackStatus, org.apache.wicket.Component component) A convenience wrapper to update a gicen Feedback Component with Status List.
static org.apache.wicket.Component	find(org.apache.wicket.MarkupContainer parent, String... s) Find Component with Id in a given parent
static String	generateJS(Class loaderClass, Map<String,Object> properties, String fileName) This will generate something like the following in your HTML header:
static String	getAbsoluteAppPath() If Application hosted @ http://abc.com/appName/ then http://abc.com/appName/ will be returned.
static org.apache.wicket.ajax.AjaxRequestTarget	getAjaxTarget(org.apache.wicket.Page page)
static org.apache.wicket.protocol.http.RequestLogger.SessionData[]	getLiveSessionInfo()
static org.apache.wicket.ajax.form.AjaxFormComponentUpdatingBehavior	getOnFieldErrorbehavior(org.apache.wicket.markup.html.WebMarkupContainer parent, org.apache.wicket.markup.html.panel.FeedbackPanel formLevelFeedback) Form Field validations @ a feild level ; where the fields can add this Behavior as long as they are decorated by a Border (namely FormComponentFeedbackBorder)
static String	getRequestUrl() Get the complete Browser request URL
static <T extends org.apache.wicket.Component> T	getRoot(T component) For any Wicket Component get root (top-most parent MarkupContainer).
static org.apache.wicket.Session	getSession(org.apache.wicket.Request request)
static User	getUser(javax.servlet.http.HttpServletRequest request) Get User from request.
static User	getUser(javax.servlet.http.HttpSession httpSession) Get User from request.
static <U extends User> U	getUserFromSession(BasicSession bs, Class<U> userTypeExpected) When user is switching between multiple context, the session type or user type may not match expected/intended type.
static <U extends User> U	getUserFromSession(org.apache.wicket.Request request, Class<U> userTypeExpected) When user is switching between multiple context, the session type or user type may not match expected/intended type.
static String	getUserId(BasicSession bs) Deprecated. Now supplied for util completeness and null check only. Use BasicSession.getUserId() instead.
static String	getUserId(javax.servlet.http.HttpServletRequest request) Get a String use id that is either a SessionID or User's id associated with the session (represented by the request).
static String	getUserId(javax.servlet.http.HttpSession httpSession) Get a String use id that is either a SessionID or User's id associated with the session.
static String	getUserId(org.apache.wicket.Request request) Get User.getId() if available from Session else get the Session.getId().
static WebUserShell	getWebUserShell(javax.servlet.http.HttpServletRequest request) Get WebUserShell from request.
static WebUserShell	getWebUserShell(javax.servlet.http.HttpSession httpSession) Get WebUserShell from request.
static <S extends org.apache.wicket.Session> S	getWicketSession(javax.servlet.http.HttpServletRequest request, Class<S> sessionType) From a Standard HttpServletRequest derive the existing Wicket Session.
static <S extends org.apache.wicket.Session> S	getWicketSession(javax.servlet.http.HttpSession httpSession, Class<S> sessionType) From a Standard HttpSession derive the existing Wicket Session.
static void	redirectExternal(String absolutePath, org.apache.wicket.Component c) Client redirect to an external URL.
static void	renderResponse(String html, org.apache.wicket.Component c) Dumps the HTML on the client browser

Methods inherited from class java.lang.Object

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

Constructor Detail

WicketUtils

public WicketUtils()

Method Detail

generateJS

public static String generateJS(Class loaderClass,
                                Map<String,Object> properties,
                                String fileName)

This will generate something like the following in your HTML header:

Parameters:

loaderClass - as Class from where (class-path) the fileName will be picked

properties - as Map of variables to insert into ${variable_name} into the file. variable_name will be the key in the map.

fileName - as String, the name of the template file.

Returns:

getRoot

public static <T extends org.apache.wicket.Component> T getRoot(T component)

For any Wicket Component get root (top-most parent MarkupContainer). if no parent, then it will return the component argument itself.

Parameters:

component -

Returns:

Component (if any parent exists it will be of type MarkupContainer)

getAbsoluteAppPath

public static String getAbsoluteAppPath()

If Application hosted @ http://abc.com/appName/ then http://abc.com/appName/ will be returned. This will NOT include an parameters or relative paths. Just the path to the application.

Returns:

getRequestUrl

public static String getRequestUrl()

Get the complete Browser request URL

Returns:

String

appendMissingCss

public static final org.apache.wicket.markup.html.WebComponent appendMissingCss(org.apache.wicket.markup.html.WebComponent wc,
                                                                                String... missingClassDef)

If model-data failed to load for the given component to be rendered, then can append a 'missing-data' class
Just a convenience method

Parameters:

wc - as WebComponent

missingClassDef - as String varargs, missingClassDef[0] is an alternate CSS ddefinition override

Returns:

WebComponent (original reference foar the sake of chaining)

find

public static org.apache.wicket.Component find(org.apache.wicket.MarkupContainer parent,
                                               String... s)

Find Component with Id in a given parent

Parameters:

parent - as parent/root component

s - as id of Component to find; one can also specify as x,y,z. Will look for x in parent, y in x and then x in y.

Returns:

@Nuallble true, if component not found TODO : write unit test cases for this

getOnFieldErrorbehavior

public static org.apache.wicket.ajax.form.AjaxFormComponentUpdatingBehavior getOnFieldErrorbehavior(org.apache.wicket.markup.html.WebMarkupContainer parent,
                                                                                                    org.apache.wicket.markup.html.panel.FeedbackPanel formLevelFeedback)

Form Field validations @ a feild level ; where the fields can add this Behavior as long as they are decorated by a Border (namely FormComponentFeedbackBorder)

Parameters:

parent -

formLevelFeedback -

Returns:

getSession

public static org.apache.wicket.Session getSession(org.apache.wicket.Request request)

getLiveSessionInfo

public static org.apache.wicket.protocol.http.RequestLogger.SessionData[] getLiveSessionInfo()

getUserId

public static String getUserId(org.apache.wicket.Request request)

Get User.getId() if available from Session else get the Session.getId(). If the session is not bound, it will bind it and force and Id out of it.

Note: This utility strictly fetches the User.getId() unlike BasicSession.getUserId()

Returns:

@nullable false

getUserId

public static String getUserId(javax.servlet.http.HttpServletRequest request)

Get a String use id that is either a SessionID or User's id associated with the session (represented by the request).

Parameters:

request - as HttpServletRequest to derive the session and related info

Returns:

@nullable false

getUserId

public static String getUserId(javax.servlet.http.HttpSession httpSession)

Get a String use id that is either a SessionID or User's id associated with the session.

Note on custom selection of id to represent session:: For a Session that uses a Wicket BasicSession one can override which id is used by overriding BasicSession.getUserId()

Parameters:

httpSession - as HttpSession to derive the session and related info

Returns:

@nullable false

getUserId

@Deprecated
public static String getUserId(BasicSession bs)

Deprecated. Now supplied for util completeness and null check only. Use BasicSession.getUserId() instead.

Get user id associated with the BasicSession

Returns:

@nullable true

See Also:

BasicSession.getUserId()

getWicketSession

public static <S extends org.apache.wicket.Session> S getWicketSession(javax.servlet.http.HttpServletRequest request,
                                                                       Class<S> sessionType)

From a Standard HttpServletRequest derive the existing Wicket Session. Useful for Web Service calls made during a Wicket Session

Parameters:

request - as HttpServletRequest

Returns:

Session

getWicketSession

public static <S extends org.apache.wicket.Session> S getWicketSession(javax.servlet.http.HttpSession httpSession,
                                                                       Class<S> sessionType)

From a Standard HttpSession derive the existing Wicket Session. Useful for Web Service calls made during a Wicket Session

Parameters:

httpSession - as HttpSession

Returns:

Session

getUserFromSession

public static <U extends User> U getUserFromSession(org.apache.wicket.Request request,
                                                    Class<U> userTypeExpected)

When user is switching between multiple context, the session type or user type may not match expected/intended type. If not simply return null else return the User object of the concerned type

Parameters:

userTypeExpected -

Returns:

user as type U, @nullable true (if no user in session of the specified type)

getUserFromSession

public static <U extends User> U getUserFromSession(BasicSession bs,
                                                    Class<U> userTypeExpected)

When user is switching between multiple context, the session type or user type may not match expected/intended type. If not simply return null else return the User object of the concerned type

Parameters:

userTypeExpected -

Returns:

user as type U, @nullable true (if no user in session of the specified type)

getUser

public static User getUser(javax.servlet.http.HttpServletRequest request)

Get User from request.

Parameters:

request - as HttpServletRequest

Returns:

User

getUser

public static User getUser(javax.servlet.http.HttpSession httpSession)

Get User from request.

Parameters:

httpSession - as HttpSession

Returns:

User

getWebUserShell

public static WebUserShell getWebUserShell(javax.servlet.http.HttpServletRequest request)

Get WebUserShell from request.

Parameters:

request - as HttpServletRequest

Returns:

WebUserShell

getWebUserShell

public static WebUserShell getWebUserShell(javax.servlet.http.HttpSession httpSession)

Get WebUserShell from request.

Parameters:

httpSession - as HttpSession

Returns:

WebUserShell

createPageLink

public static String createPageLink(List<String> paramInclude,
                                    List<String> paramIgnore,
                                    String prefix,
                                    org.apache.wicket.Request request,
                                    String suffix)

Re-Create a link with specific params only; cleans by recreating link with required params only

Parameters:

paramInclude - as List of String params from request

paramIgnore - as List of String params from request (will override if in conflict with included params)

prefix - as the Opening tag details to this link including protocl and domain name before the actual relative path

request - as Request

suffix - as suffix ending tag details to this link

Returns:

String as link

redirectExternal

public static void redirectExternal(String absolutePath,
                                    org.apache.wicket.Component c)

Client redirect to an external URL.
Note: For internal redirects use RestartResponseException

Parameters:

absolutePath - as String representing the absolute path of the URL

container - as Component that calls this helper method

renderResponse

public static void renderResponse(String html,
                                  org.apache.wicket.Component c)

Dumps the HTML on the client browser

Parameters:

html - as String

container - as Component that calls this helper method

getAjaxTarget

public static org.apache.wicket.ajax.AjaxRequestTarget getAjaxTarget(org.apache.wicket.Page page)

feedback

public static void feedback(List<Status> feedbackStatus,
                            org.apache.wicket.Component component)

A convenience wrapper to update a gicen Feedback Component with Status List.

Parameters:

feedbackStatus - as List of Status

component - as Component