Package mc.core.domain.base.rest

Class RESTContext

java.lang.Object

mc.core.domain.base.rest.RESTContext

@Path("/")
@RequestScoped
public class RESTContext
extends Object

REST context and utilities for all RI API classes

Constructor Summary

Constructors

Constructor	Description
RESTContext()

Method Summary

Modifier and Type	Method	Description
DataMap	getDataMap()
List<DataMap>	getDataMapList()
List<org.apache.commons.fileupload.FileItem>	getFileItems()
org.apache.commons.fileupload.FileItem	getFirstFileItem()
String	getParameter(String name)
javax.ws.rs.core.Response	response()	build a 200 response
javax.ws.rs.core.Response	response(Object data)	build a 200 response including entity data as messageBody.
<T extends IBaseEntity> javax.ws.rs.core.Response	response(IBaseDO<T> dobj, List<T> entities)
<T extends IBaseEntity> javax.ws.rs.core.Response	response(IBaseDO<T> dobj, List<T> entities, DataMap resultMap)
<T extends IBaseEntity> javax.ws.rs.core.Response	response(IBaseDO<T> dobj, T entity)
<T extends IBaseEntity> javax.ws.rs.core.Response	responseSearch(IBaseDO<T> dobj, List<T> result, mc.core.system.search.SearchResult sr, boolean statelessSession, int start, int end)	creates a Response that contains information to search result as well as the list (page) of found entities.
DataMap	toDataMap(String dataAsJson)

Methods inherited from class java.lang.Object

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

Constructor Details

RESTContext

public RESTContext()

Method Details

getDataMap

public DataMap getDataMap()
                   throws ApplicationException

Throws:

ApplicationException

toDataMap

public DataMap toDataMap(String dataAsJson)
                  throws ApplicationException

Throws:

ApplicationException

getDataMapList

public List<DataMap> getDataMapList()
                             throws ApplicationException

Throws:

ApplicationException

getParameter

public String getParameter(String name)

getFileItems

public List<org.apache.commons.fileupload.FileItem> getFileItems()

getFirstFileItem

public org.apache.commons.fileupload.FileItem getFirstFileItem()

response

public javax.ws.rs.core.Response response()

build a 200 response

response

public javax.ws.rs.core.Response response(Object data)

build a 200 response including entity data as messageBody. JAX-RS will convert to json

response

public <T extends IBaseEntity>
javax.ws.rs.core.Response response(IBaseDO<T> dobj,
 T entity)
                            throws ApplicationException,
IOException

Throws:

ApplicationException

IOException

response

public <T extends IBaseEntity>
javax.ws.rs.core.Response response(IBaseDO<T> dobj,
 List<T> entities)
                            throws ApplicationException,
IOException

Throws:

ApplicationException

IOException

response

public <T extends IBaseEntity>
javax.ws.rs.core.Response response(IBaseDO<T> dobj,
 List<T> entities,
 DataMap resultMap)
                            throws ApplicationException,
IOException

Throws:

ApplicationException

IOException

responseSearch

public <T extends IBaseEntity>
javax.ws.rs.core.Response responseSearch(IBaseDO<T> dobj,
 List<T> result,
 mc.core.system.search.SearchResult sr,
 boolean statelessSession,
 int start,
 int end)
                                  throws ApplicationException,
IOException

creates a Response that contains information to search result as well as the list (page) of found entities.

Parameters:

dobj - DO for result entities

result - list of result entities

sr - search result

statelessSession - boolean

start - start index of result. default is 0 if not set. optional

end - end index of result. get first page if not set. optional

Returns:

Response

Throws:

ApplicationException

IOException