com.neurosys.user.service.jaxrs

Class AbstractAnyUserUpdateService<U extends User,E,S>

java.lang.Object

com.neurosys.amorphous.service.jaxrs.AnyWebService

com.neurosys.amorphous.service.jaxrs.SecurableService

com.neurosys.user.service.jaxrs.AbstractAnyUserUpdateService<U,E,S>

Type Parameters:

U - as User

E - as Shell payload type

S - as Session type

Direct Known Subclasses:

ServletAnyUserUpdateService, WicketAnyUserUpdateService

public abstract class AbstractAnyUserUpdateService<U extends User,E,S>
extends SecurableService

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).

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
AbstractAnyUserUpdateService()
AbstractAnyUserUpdateService(boolean checkAuthFiltered)

Method Summary

Modifier and Type	Method and Description
void	cleanRedundantSessions(Set<String> keepSessionIds, S session) Opportunity to clean redundant sessions
protected abstract S	getSession()
Map<String,Map>	getUserActivityMap(S session)
protected abstract UserSessionAdapter<?,S,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.
Object	queryWithinContext(String contextNameId, String actionId, String json, String jsonBody) Same as query(String, String, String, String) except that in addition to the Query, the user object is passed automatically in session to the Array or Map of parameters.
protected void	setPingUserData(Map<String,Object> activityMapForSession, S session)

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

AbstractAnyUserUpdateService

public AbstractAnyUserUpdateService()

AbstractAnyUserUpdateService

public AbstractAnyUserUpdateService(boolean checkAuthFiltered)

Method Detail

getUserSessionAdapter

protected abstract UserSessionAdapter<?,S,U> getUserSessionAdapter()

getSession

protected abstract S getSession()

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

Parameters:

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

Throws:

Exception

setPingUserData

protected void setPingUserData(Map<String,Object> activityMapForSession,
                               S 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.

Parameters:

contextNameId - as String; a classification for the manner in which the Query is called. Can allow for better and custom security or context 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

queryWithinContext

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

Same as query(String, String, String, String) except that in addition to the Query, the user object is passed automatically in session to the Array or Map of parameters. This method also adds a User object as sessionUser in the Map or @ the end of the array or

Parameters:

contextNameId - as String; a classification for the manner in which the Query is called. Can allow for better and custom security or context 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(S session)
                                   throws AuthorizationException

Parameters:

session - Session demanding the info

Returns:

@nullable true

Throws:

AuthorizationException

cleanRedundantSessions

public void cleanRedundantSessions(Set<String> keepSessionIds,
                                   S session)
                            throws AuthorizationException

Opportunity to clean redundant sessions

Throws:

AuthorizationException