com.neurosys.amorphous.service.jaxrs

Class GenericFormService

java.lang.Object

com.neurosys.amorphous.service.jaxrs.AnyWebService

com.neurosys.amorphous.service.jaxrs.SecurableService

com.neurosys.amorphous.service.jaxrs.GenericFormService

All Implemented Interfaces:

ChangeGenerator<Object[]>

@Path(value="/")
 @Consumes(value={"application/json","application/x-www-form-urlencoded"})
 @Produces(value="application/json")
 @Secured(value={"ROLE_USER","ROLE_ADMIN"})
public class GenericFormService
extends SecurableService
implements ChangeGenerator<Object[]>

Provide a generic service(s) that can act as a Form that performs the following in a standard manner:

1. Accept a HTTP POST form in application/x-www-form-urlencoded
2. The form fields are server entity field names
3. The service will then pass the HttpServletRequest to the submit Transformer
4. The Submit transformer result will be wrapped in a Response object and sent back synchronously to the client
5. If there are any listeners they will be also invoked synchronously. One may use an Asynchronous wrapper to make listener callbacks asynchronous

This service should have a separate instance for each type of Form

Sample usage:

setSubmitTransformer(Transformer) = TransformerChain {

1. ServletRequestToEntitiesTransformer
2. Some custom Transfomer.transform(Map<Class, Entity>)

}

Since this implements ChangeGenerator; it will also generate Events of Type

• Object[]{"submitSuccess", HttpServletRequest, Response}
• Object[]{"submitFail", HttpServletRequest, Response}
• Object[]{"validationSuccess", HttpServletRequest, Response}
• Object[]{"validationFail", HttpServletRequest, Response}

Author:

Arjun Dhar

Field Summary

Fields

Modifier and Type	Field and Description
static String	USER_REQ_CONTEXT_KEY The input Map passed to the submitTransformer will contain an entry for the current User request

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

applicationContext, CACHE, NO_CACHE, request, response

Constructor Summary

Constructors

Constructor and Description
GenericFormService()
GenericFormService(boolean checkAuthFiltered)

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener changeListener) Allow Notify all ChangeListeners about a change
List	getListeners() Get list directly.
org.apache.commons.collections.Transformer	getSubmitTransformer() Takes a List of entities defined in sequence by #entities and validates them.
org.apache.commons.collections.Transformer	getValidationTransformer() Takes a List of entities defined in sequence by #entities and validates them.
void	notifyAllListeners(Object[] object) Whenever a node is selected/updated, it also notifies its listeners.
void	setListeners(List listeners) Set list directly.
void	setSubmitTransformer(org.apache.commons.collections.Transformer submitTransformer) Takes a List of entities defined in sequence by #entities and validates them.
void	setValidationTransformer(org.apache.commons.collections.Transformer validationTransformer) Takes a List of entities defined in sequence by #entities and validates them.
Response	submit(Object r)
Response	submitForm(javax.ws.rs.core.MultivaluedMap map)
Response	submitJSON(Map data)
Response	validate(Object r)
Response	validateForm(javax.ws.rs.core.MultivaluedMap map)
Response	validateJSON(Map data)

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

USER_REQ_CONTEXT_KEY

public static final String USER_REQ_CONTEXT_KEY

The input Map passed to the submitTransformer will contain an entry for the current User request

See Also:

Constant Field Values

Constructor Detail

GenericFormService

public GenericFormService()

GenericFormService

public GenericFormService(boolean checkAuthFiltered)

Method Detail

submitJSON

@POST
 @Path(value="submitJSON")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public Response submitJSON(Map data)

submitForm

@POST
 @Path(value="submit")
 @Consumes(value="application/x-www-form-urlencoded")
 @Produces(value="application/json")
public Response submitForm(javax.ws.rs.core.MultivaluedMap map)

submit

public Response submit(Object r)

validateJSON

@POST
 @Path(value="validateJSON")
 @Consumes(value="application/json")
 @Produces(value="application/json")
public Response validateJSON(Map data)

validateForm

@POST
 @Path(value="validate")
 @Consumes(value="application/x-www-form-urlencoded")
 @Produces(value="application/json")
public Response validateForm(javax.ws.rs.core.MultivaluedMap map)

validate

public Response validate(Object r)

getValidationTransformer

public org.apache.commons.collections.Transformer getValidationTransformer()

Takes a List of entities defined in sequence by #entities and validates them. The first element in this List will always be the HttpServletRequest that triggered the webserivce method
The transformer can Throw an Exception or return any object. If the Transformer returns a null then it implies no validation was required and be interpreted as a success.

Can be null:

true

setValidationTransformer

public void setValidationTransformer(org.apache.commons.collections.Transformer validationTransformer)

Takes a List of entities defined in sequence by #entities and validates them. The first element in this List will always be the HttpServletRequest that triggered the webserivce method
The transformer can Throw an Exception or return any object. If the Transformer returns a null then it implies no validation was required and be interpreted as a success.

Can be null:

true

getSubmitTransformer

public org.apache.commons.collections.Transformer getSubmitTransformer()

Takes a List of entities defined in sequence by #entities and validates them. The first element in this List will always be the HttpServletRequest that triggered the webserivce method
If there is an error during submission, the response is same as the validationTransformer. If there is any exception, an exception will be thrown. else any object or null will be returned in a success scenario.

setSubmitTransformer

public void setSubmitTransformer(org.apache.commons.collections.Transformer submitTransformer)

Takes a List of entities defined in sequence by #entities and validates them. The first element in this List will always be the HttpServletRequest that triggered the webserivce method
If there is an error during submission, the response is same as the validationTransformer. If there is any exception, an exception will be thrown. else any object or null will be returned in a success scenario.

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[]>