com.neurosys.user.service.jaxrs

Class WicketBasicSessionAuthService<U extends User,S extends BasicSession>

java.lang.Object

com.neurosys.amorphous.service.jaxrs.AnyWebService

com.neurosys.user.service.jaxrs.WicketBasicSessionAuthService<U,S>

All Implemented Interfaces:

ChangeGenerator<Object>

@Path(value="/")
 @Consumes(value={"application/json","application/text","text/html","application/x-www-form-urlencoded"})
 @Produces(value="application/json;charset=utf-8")
public class WicketBasicSessionAuthService<U extends User,S extends BasicSession>
extends AnyWebService
implements ChangeGenerator<Object>

Default Web Service to handle Session based Auth. A session based auth token is a Cookie
By default authUserService uses "wicketBasicSessionAuthService"

For this Endpoint to work, it requires Wicket to setup the RequestCycle for it. An example of this sequence:

1. Setup Wicket context, i,e. Application & RequestCycle for thread: Ensure Application is in the ThreadLocal. So ensure SiteWicketFilter.setupWicketContext(javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse) sets the Wicket Context. By filter <init-param> set provideApplicationToPathPattern to include this endpoint
2. #login(Principal)

Author:

Arjun Dhar

See Also:

(wicketBasicSessionAuthService) which is the backing service provider for the Auth Logic

Field Summary

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

applicationContext, CACHE, NO_CACHE, request, response

Constructor Summary

Constructors

Constructor and Description
WicketBasicSessionAuthService()

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener changeListener) Allow Notify all ChangeListeners about a change
Function<U,Object>	getAuthenticatedUserToResponseBody() Define the response for a given User
AbstractSessionAuthService<User,S>	getAuthUserService()
List	getListeners() Get list directly.
Function<U,javax.ws.rs.core.NewCookie>	getUserToCookie() Session based Auth-Token (Cookie)
javax.ws.rs.core.Response	login(BasicAuthPrincipal principal) login.
javax.ws.rs.core.Response	loginAjax(String json) login for AJAX Post style request.
String	logout()
void	notifyAllListeners(Object object) Whenever a node is selected/updated, it also notifies its listeners.
void	setAuthenticatedUserToResponseBody(Function<U,Object> authenticatedUserToResponseBody) Define the response for a given User
void	setAuthUserService(AbstractSessionAuthService<User,S> authUserService)
void	setListeners(List listeners) Set list directly.
void	setUserToCookie(Function<U,javax.ws.rs.core.NewCookie> userToCookie) Session based Auth-Token (Cookie)
javax.ws.rs.core.Response	testLogin(String userId, String password)
protected Runnable	testSessionInvalidator(int seconds, String userId, javax.servlet.http.HttpServletRequest request) A factory method to create a Runnable to auto invalidate the session

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

filter, getCacheDef, getTestString, query, query

Methods inherited from class java.lang.Object

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

Constructor Detail

WicketBasicSessionAuthService

public WicketBasicSessionAuthService()

Method Detail

login

@POST
 @Path(value="login")
 @Consumes(value={"application/json","application/x-www-form-urlencoded"})
 @Produces(value="application/json")
public javax.ws.rs.core.Response login(@FormParam(value="principal")
                                                                                                                                                                                   BasicAuthPrincipal principal)
                                                                                                                                                                            throws Exception

login. Assumes Wicket RequestCycle is setup

Parameters:

principal - as a Form Field

Returns:

Response

Throws:

Exception

See Also:

SiteWicketFilter}, WicketRequestCycleInterceptor}

loginAjax

@POST
 @Path(value="login-ajax")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public javax.ws.rs.core.Response loginAjax(String json)
                                                                                                                                               throws Exception

login for AJAX Post style request. Assumes Wicket RequestCycle is setup

Parameters:

principal - as JSON DATA

Returns:

Response

Throws:

Exception

See Also:

SiteWicketFilter}, WicketRequestCycleInterceptor}

testSessionInvalidator

protected Runnable testSessionInvalidator(int seconds,
                                          String userId,
                                          javax.servlet.http.HttpServletRequest request)

A factory method to create a Runnable to auto invalidate the session

Parameters:

seconds - in int to wait before invlaidating the session

userId - as String

request - as HttpRequest

Returns:

Runnable

testLogin

@GET
 @Path(value="test-login")
 @Consumes(value="text/html")
 @Produces(value="application/json")
public javax.ws.rs.core.Response testLogin(@QueryParam(value="userId")
                                                                                                                                              String userId,
                                                                                                                                              @QueryParam(value="password")
                                                                                                                                              String password)
                                                                                                                                       throws Exception

Throws:

Exception

logout

@GET
 @Path(value="logout")
public String logout()

getAuthUserService

public AbstractSessionAuthService<User,S> getAuthUserService()

Default value:

com.neurosys.user.service.WicketBasicSessionAuthService (wicketBasicSessionAuthService)

setAuthUserService

public void setAuthUserService(AbstractSessionAuthService<User,S> authUserService)

Default value:

com.neurosys.user.service.WicketBasicSessionAuthService (wicketBasicSessionAuthService)

getUserToCookie

public Function<U,javax.ws.rs.core.NewCookie> getUserToCookie()

Session based Auth-Token (Cookie)

Parameters:

user - as User type

Returns:

Cookie

setUserToCookie

public void setUserToCookie(Function<U,javax.ws.rs.core.NewCookie> userToCookie)

Session based Auth-Token (Cookie)

Parameters:

user - as User type

getAuthenticatedUserToResponseBody

public Function<U,Object> getAuthenticatedUserToResponseBody()

Define the response for a given User

Parameters:

user - as User

Returns:

Object (Map or JSON or String as WebService response). By default returns a JSON string map of JSESSIONID, userId, authorizations, roles, bitmask

setAuthenticatedUserToResponseBody

public void setAuthenticatedUserToResponseBody(Function<U,Object> authenticatedUserToResponseBody)

Define the response for a given User

Parameters:

user - as User

addChangeListener

public void addChangeListener(ChangeListener changeListener)

Description copied from interface: ChangeGenerator

Allow Notify all ChangeListeners about a change

Specified by:

addChangeListener in interface ChangeGenerator<Object>

notifyAllListeners

public void notifyAllListeners(Object object)

Description copied from interface: ChangeGenerator

Whenever a node is selected/updated, it also notifies its listeners.

Specified by:

notifyAllListeners in interface ChangeGenerator<Object>

getListeners

public List getListeners()

Description copied from interface: ChangeGenerator

Get list directly. Support DI; like Spring IOC

Specified by:

getListeners in interface ChangeGenerator<Object>

setListeners

public void setListeners(List listeners)

Description copied from interface: ChangeGenerator

Set list directly. Support DI; like Spring IOC

Specified by:

setListeners in interface ChangeGenerator<Object>