com.neurosys.user.service.jaxrs

Class WicketAnyUserUpdateService<U extends User,E>

java.lang.Object

com.neurosys.amorphous.service.jaxrs.AnyWebService

com.neurosys.amorphous.service.jaxrs.SecurableService

com.neurosys.user.service.jaxrs.AbstractAnyUserUpdateService<U,E,org.apache.wicket.Session>

com.neurosys.user.service.jaxrs.WicketAnyUserUpdateService<U,E>

@Path(value="/")
 @Consumes(value={"application/json","application/text","text/html","application/x-www-form-urlencoded"})
 @Produces(value="application/json;charset=utf-8")
public class WicketAnyUserUpdateService<U extends User,E>
extends AbstractAnyUserUpdateService<U,E,org.apache.wicket.Session>

Web Service Layer for any User (Logged in or Guest) supports generic user related methods. See SecurableService.query(String, Object) and query(String, String, String, String).
To use this service, insert JavaScript on Page:
<script type="text/javascript" src="js/useraction.min.js"></script> <script type="text/javascript"> var pingUrl = getBaseUrl(window.location.href) + (typeof SITE_CONTEXT!='undefined'?SITE_CONTEXT:'') + '/services/anyuser/ping'; var ua = new onUserAction(10, function() {$.get(pingUrl+'?action='+window.location.pathname);});

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,SoftReference<Map>>	userActivity

Fields inherited from class com.neurosys.amorphous.service.jaxrs.AnyWebService

applicationContext, CACHE, NO_CACHE, request, response

Constructor Summary

Constructors

Constructor and Description
WicketAnyUserUpdateService()
WicketAnyUserUpdateService(boolean checkAuthFiltered)

Method Summary

Modifier and Type	Method and Description
void	cleanRedundantSessions(Set<String> keepSessionIds, org.apache.wicket.Session session) Opportunity to clean redundant sessions
protected org.apache.wicket.Session	getSession()
Map<String,Map>	getUserActivityMap(org.apache.wicket.Session session)
protected UserSessionAdapter<?,org.apache.wicket.Session,U>	getUserSessionAdapter()
void	ping(String action) A way the User-Agent / Browser can let the server know the user is active and update its last active state
Object	query(String contextNameId, String actionId, String json, String jsonBody) Example: http://host/services/anyuser/userAction/all/contactUs?p={'fname':'xxxx','lname':'yyyy'...} http://host/services/anyuser/userAction/all/contactUs?p={'fname':'xxxx','lname':'yyyy'...} Note: This method supports JSON data as a query param and a form param.
protected void	setPingUserData(Map<String,Object> activityMapForSession, org.apache.wicket.protocol.http.WebSession session)
void	setUserSessionAdapter(UserSessionAdapter<?,org.apache.wicket.Session,U> userSessionAdapter)

Methods inherited from class com.neurosys.user.service.jaxrs.AbstractAnyUserUpdateService

queryWithinContext, setPingUserData

Methods inherited from class com.neurosys.amorphous.service.jaxrs.SecurableService

checkAuthFilterInvoked, filter, query

Methods inherited from class com.neurosys.amorphous.service.jaxrs.AnyWebService

filter, getCacheDef, getTestString, query

Methods inherited from class java.lang.Object

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

Field Detail

userActivity

protected Map<String,SoftReference<Map>> userActivity

Constructor Detail

WicketAnyUserUpdateService

public WicketAnyUserUpdateService()

WicketAnyUserUpdateService

public WicketAnyUserUpdateService(boolean checkAuthFiltered)

Method Detail

ping

@GET
 @Path(value="ping")
 @Consumes(value="text/plain")
 @Produces(value="text/plain")
public void ping(@QueryParam(value="action")
                                                                                                         String action)
                                                                                                  throws Exception

A way the User-Agent / Browser can let the server know the user is active and update its last active state

Overrides:

ping in class AbstractAnyUserUpdateService<U extends User,E,org.apache.wicket.Session>

Parameters:

action - as the last action details passed from the User Agent

Throws:

Exception

setPingUserData

protected void setPingUserData(Map<String,Object> activityMapForSession,
                               org.apache.wicket.protocol.http.WebSession session)

query

@POST
 @Path(value="userAction/{contextNameId}/{actionId}")
 @Produces(value="application/json")
public Object query(@PathParam(value="contextNameId")
                                                                                                                     String contextNameId,
                                                                                                                     @PathParam(value="actionId")
                                                                                                                     String actionId,
                                                                                                                     @QueryParam(value="p")
                                                                                                                     String json,
                                                                                                                     @FormParam(value="f")
                                                                                                                     String jsonBody)
                                                                                                              throws Exception

Example: http://host/services/anyuser/userAction/all/contactUs?p={'fname':'xxxx','lname':'yyyy'...}
http://host/services/anyuser/userAction/all/contactUs?p={'fname':'xxxx','lname':'yyyy'...}

Note: This method supports JSON data as a query param and a form param. If both are provided the query param will be ignored.

Example: http://host/services/anyuser/userAction/all/contactUs?p={'fname':'xxxx','lname':'yyyy'...}
http://host/services/anyuser/userAction/all/contactUs?p={'fname':'xxxx','lname':'yyyy'...}

Note: This method supports JSON data as a query param and a form param. If both are provided the query param will be ignored.

Overrides:

query in class AbstractAnyUserUpdateService<U extends User,E,org.apache.wicket.Session>

Parameters:

contextNameId - as String; a classification for the manner in which the Query is called. Can allow for better and custom security or context or SEO related aspects.

actionId - as String (should match a Spring Transformer bean id that accepts an Object array as params)

p - as Query Param JSON Object String that is converted into a Map or Array of variables @nullable true

f - as Form Param JSON Object String that is converted into a Map or Array of variables @nullable true

Returns:

should be either String type or JSON

Throws:

Exception

getUserActivityMap

public Map<String,Map> getUserActivityMap(org.apache.wicket.Session session)
                                   throws AuthorizationException

Overrides:

getUserActivityMap in class AbstractAnyUserUpdateService<U extends User,E,org.apache.wicket.Session>

Parameters:

session - Session demanding the info

Returns:

@nullable true

Throws:

AuthorizationException

cleanRedundantSessions

public void cleanRedundantSessions(Set<String> keepSessionIds,
                                   org.apache.wicket.Session session)
                            throws AuthorizationException

Opportunity to clean redundant sessions

Overrides:

cleanRedundantSessions in class AbstractAnyUserUpdateService<U extends User,E,org.apache.wicket.Session>

Throws:

AuthorizationException

getUserSessionAdapter

protected UserSessionAdapter<?,org.apache.wicket.Session,U> getUserSessionAdapter()

Specified by:

getUserSessionAdapter in class AbstractAnyUserUpdateService<U extends User,E,org.apache.wicket.Session>

setUserSessionAdapter

public void setUserSessionAdapter(UserSessionAdapter<?,org.apache.wicket.Session,U> userSessionAdapter)

getSession

protected org.apache.wicket.Session getSession()

Specified by:

getSession in class AbstractAnyUserUpdateService<U extends User,E,org.apache.wicket.Session>